wrote some comment lines describing the rescue code

[citadel.git] / citadel / server / user_ops.c

diff --git a/citadel/server/user_ops.c b/citadel/server/user_ops.c
index 55cbf574a0e4df7ecbcda0a1abd176e3f3fe5032..f9a7f7146b28be03395b86b96d56cbe75688544c 100644 (file)
--- 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));