summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Rajnoha <prajnoha@redhat.com>2015-04-30 14:28:26 +0200
committerPeter Rajnoha <prajnoha@redhat.com>2015-04-30 14:28:26 +0200
commit25e7178e5955231295cf96de06ef9717fa029013 (patch)
tree93f4941aae337236f90eb1711bbe696424a88e37
parentd2c2718c11dc834a79a76acf34d76902daac5752 (diff)
downloadlvm2-25e7178e5955231295cf96de06ef9717fa029013.tar.gz
cleanup: config_settings.h: add some comments
-rw-r--r--lib/config/config_settings.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/config/config_settings.h b/lib/config/config_settings.h
index aaaa3a350..f03ec09b1 100644
--- a/lib/config/config_settings.h
+++ b/lib/config/config_settings.h
@@ -18,10 +18,14 @@
* cfg_section(id, name, parent, flags, since_version, comment)
*
* - define a configuration setting of simple type:
- * cfg(id, name, parent, flags, type, default_value, since_version, comment)
+ * cfg(id, name, parent, flags, type, default_value, since_version, unconfigured_default_value, comment)
*
* - define a configuration array of one or more types:
- * cfg_array(id, name, parent, flags, types, default_value, since_version, comment)
+ * cfg_array(id, name, parent, flags, types, default_value, since_version, unconfigured_default_value, comment)
+ *
+ * The unconfigured_default_value is used as a default value which is
+ * in "@...@" form and which is then substitued with concrete value while
+ * running configure (see also 'lvmconfig --type default --unconfigured').
*
* If default value can't be assigned statically because it depends on some
* run-time checks or if it depends on other settings already defined,