user_list.c: Fix documentation of populate_user_list().

[paraslash.git] / user_list.c

diff --git a/user_list.c b/user_list.c
index 45501ad1e2984147839d2098597ee06db902fa39..8648f10b049679046e5812677e34f5c2b9e06132 100644 (file)
--- a/user_list.c
+++ b/user_list.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -19,9 +19,10 @@
 static struct list_head user_list;
 
 /*
- * lookup user in user list file. Fills in a user struct containing
- * filename of the user's public key as well as the permissions of that user.
- * Returns 1 on success, 0 if user does not exist and < 0 on errors.
+ * Fill the list of users known to para_server.
+ *
+ * Populates a linked list of all users in \a user_list_file.  Returns on
+ * success, calls exit() on errors.
  */
 static void populate_user_list(char *user_list_file)
 {