From 34e23233ce2bdf723c6b716e3b11c15e4dd34786 Mon Sep 17 00:00:00 2001
From: Mukund Sivaraman <muks@banu.com>
Date: Tue, 15 Sep 2009 02:00:20 +0530
Subject: Add doc for change_user()

---
 src/main.c | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src')

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)
 {
-- 
cgit v1.2.3