]> mj.ucw.cz Git - libucw.git/commitdiff
ucw docs: tweaks in conf.html
authorMichal Vaner <vorner@ucw.cz>
Wed, 22 Oct 2008 12:03:42 +0000 (14:03 +0200)
committerMichal Vaner <vorner@ucw.cz>
Wed, 22 Oct 2008 12:03:42 +0000 (14:03 +0200)
ucw/conf.h
ucw/getopt.h

index dc1d14549d133a1d351b0be6d55c41e602a68e48..7b32451975260c87fdbb4f7859efe887d7c04067 100644 (file)
@@ -277,17 +277,17 @@ struct cf_section {                       /** A section. **/
  **/
 #define CF_LOOKUP_DYN(n,p,t,c) { .cls = CC_DYNAMIC, .type = CT_LOOKUP, .name = n, .number = c, .ptr = CHECK_PTR_TYPE(p,int**), .u.lookup = t }
 /**
- * A user defined type.
+ * A user-defined type.
  * See <<custom_parser,creating custom parsers>> section if you want to know more.
  **/
 #define CF_USER(n,p,t)         { .cls = CC_STATIC, .type = CT_USER, .name = n, .number = 1, .ptr = p, .u.utype = t }
 /**
- * Static array of user defined types (all of the same type).
+ * Static array of user-defined types (all of the same type).
  * See <<custom_parser,creating custom parsers>> section.
  **/
 #define CF_USER_ARY(n,p,t,c)   { .cls = CC_STATIC, .type = CT_USER, .name = n, .number = c, .ptr = p, .u.utype = t }
 /**
- * Dynamic array of user defined types.
+ * Dynamic array of user-defined types.
  * See <<custom_parser,creating custom parsers>> section.
  **/
 #define CF_USER_DYN(n,p,t,c)   { .cls = CC_DYNAMIC, .type = CT_USER, .name = n, .number = c, .ptr = p, .u.utype = t }
index 3a5592470d1318aae8f26fb8ff5fb80aab8d556e..453d382ed83948c8b8defc77873c6250a385d201 100644 (file)
@@ -31,8 +31,12 @@ void reset_getopt(void);     /** If you want to start parsing of the arguments from
  * The default config (DEFAULT_CONFIG config option) or NULL if already loaded.
  * You can set it to something else manually.
  */
-extern char *cf_def_file;              /* DEFAULT_CONFIG; NULL if already loaded */
-extern char *cf_env_file;              /** ENV_VAR_CONFIG **/
+extern char *cf_def_file;
+/**
+ * Name of environment variable that can override what configuration
+ * is loaded.
+ **/
+extern char *cf_env_file;
 int cf_reload(const char *file);       /** Reload configuration from @file, replace the old one. **/
 int cf_load(const char *file);         /** Load configuration from @file. **/
 /**