From: Art Cancro <ajc@citadel.org>
Date: Wed, 14 Jun 2023 15:41:12 +0000 (-0900)
Subject: wrote some comment lines describing the rescue code
X-Git-Tag: v981~75
X-Git-Url: https://code.citadel.org/?a=commitdiff_plain;h=3978e74a389154cfffae31e8fc23d43570b44a07;p=citadel.git

wrote some comment lines describing the rescue code
---

diff --git a/citadel/server/user_ops.c b/citadel/server/user_ops.c
index 55cbf574a..f9a7f7146 100644
--- a/citadel/server/user_ops.c
+++ b/citadel/server/user_ops.c
@@ -1139,7 +1139,9 @@ int InitialMailCheck() {
 }
 
 
-// Undocumented rescue mode
+// This is an undocumented rescue mode that can be used to rewrite an admin user account that has been corrupted.
+// To prevent abuse, it can only run as a one-shot when the server is not otherwise operational.
+// Don't use this without asking about it.
 void undocumented_rescue_mode(char *rescue_string) {
 	struct ctdluser usbuf;
 	memset(&usbuf, 0, sizeof(struct ctdluser));