# HG changeset patch
# User Binki <ohnobinki@ohnopublishing.net>
# Date 2009-07-25 16:16:31
# Node ID 13880b12fb9b131adb2925e9af037b22f4710955
# Parent  dd014aec7d564b095a8fcb302fcd499f313177a8

fixed up options.h docs

diff --git a/src/common/options.h b/src/common/options.h
--- a/src/common/options.h
+++ b/src/common/options.h
@@ -47,10 +47,10 @@ struct options_common
 
   \param mycfg will be set to the section of the configuration file specific to the caller (client or server specific section). Who is supposed to free this variable?
   \param myopts holds the caller's confuse option declarations
-  \param myname holds the name of the section of the config file that refers to mycfg and myopts
+  \param myname holds the name of the section of the config file that refers to mycfg and myopts -- currently ``slave'', ``client'', and ``server'' are valid
 
   \param allopts will be set to a pointer that many functions need for operation
-  \param argc the argc that was passed to main()
+  \param argc the argc that was passed to main() -- these will be used to determine the location of the config file
   \param argv the argv that was passed to main()
  */
 int options_init(int argc, char *argv[], cfg_t **mycfg, cfg_opt_t *myopts, char *myname, struct options_common **allopts);