Add doc for change_user()

1 files changed, 8 insertions, 0 deletions

diff --git a/src/main.c b/src/main.c
index 7a3cae8..0e0478c 100644
--- a/src/main.c
+++ b/src/main.c
@@ -205,6 +205,14 @@ process_cmdline (int argc, char **argv)
         }
 }
 
+/**
+ * change_user:
+ * @program: The name of the program. Pass argv[0] here.
+ *
+ * This function tries to change UID and GID to the ones specified in
+ * the config file. This function is typically called during
+ * initialization when the effective user is root.
+ **/
 static void
 change_user (const char *program)
 {