user_list.c: Fix documentation of populate_user_list().
[paraslash.git] / user_list.c
index 4f63f63..8648f10 100644 (file)
 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)
 {