Document may_change_field().

diff --git a/ChangeLog b/ChangeLog
index ccfe0f97702c6e392b9615664470e3fd92d44643..cd6dcb19f72685963bb3019bad9779a58f5ebef1 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,6 +7,7 @@
        * src/chfn.c: Before pam_end(), the return value of the previous
        pam API was already checked. No need to validate it again.
        * src/chfn.c: Avoid implicit brackets.
+       * src/chfn.c: Document may_change_field().
 
 2007-12-31  Nicolas François  <nicolas.francois@centraliens.net>
 

diff --git a/src/chfn.c b/src/chfn.c
index 1456dd1cde9ae9dcbea6cf8ac40ca04507c3ed83..6380c217bd28fc48db4969b7b4eb4f9534aafc73 100644 (file)
--- a/src/chfn.c
+++ b/src/chfn.c
@@ -105,7 +105,16 @@ static void usage (void)
        exit (E_USAGE);
 }
 
-
+/*
+ * may_change_field - indicate if the user is allowed to change a given field
+ *                    of her gecos information
+ *
+ *     root can change any field.
+ *
+ *     field should be one of 'f', 'r', 'w', 'h'
+ *
+ *     Return 1 if the user can change the field and 0 otherwise.
+ */
 static int may_change_field (int field)
 {
        const char *cp;