* libmisc/isexpired.c: Document the isexpired return value.

diff --git a/ChangeLog b/ChangeLog
index 60c48022d123abc0fc7c425fe60692adfd14de62..44930bedb8fd70113d9f9a36e0e608bbb3ffcf9f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2009-04-04  Nicolas François  <nicolas.francois@centraliens.net>
+
+       * libmisc/isexpired.c: Document the isexpired return value.
+
 2009-04-04  Nicolas François  <nicolas.francois@centraliens.net>
 
        * libmisc/age.c: Return a specific message when sp_lstchg is null.

diff --git a/libmisc/isexpired.c b/libmisc/isexpired.c
index e93c9d49b2498e71ce9f0ed2a2e7b54911f4b658..728159fb5f84451f39b1ac5ce661b48a8bcde491 100644 (file)
--- a/libmisc/isexpired.c
+++ b/libmisc/isexpired.c
@@ -51,6 +51,13 @@
  *
  *     isexpired calculates the expiration date based on the
  *     password expiration criteria.
+ *
+ * Return value:
+ *     0: The password is still valid
+ *     1: The password has expired, it must be changed
+ *     2: The password has expired since a long time and the account is
+ *        now disabled. (password cannot be changed)
+ *     3: The account has expired
  */
 int isexpired (const struct passwd *pw, const struct spwd *sp)
 {