summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris St. Pierre <chris.a.st.pierre@gmail.com>2012-01-23 16:33:19 -0500
committerChris St. Pierre <chris.a.st.pierre@gmail.com>2012-01-23 16:33:19 -0500
commit4367811c2811d0305cd2be8a1bb7b44fff7a1329 (patch)
tree34de08bead54ebdf95295786945086bca75e7d25 /doc
parentadcd396e3dad04030ccbbff5c77c56df566dacab (diff)
downloadbcfg2-4367811c2811d0305cd2be8a1bb7b44fff7a1329.tar.gz
bcfg2-4367811c2811d0305cd2be8a1bb7b44fff7a1329.tar.bz2
bcfg2-4367811c2811d0305cd2be8a1bb7b44fff7a1329.zip
clarified handling of boolean values in packages.conf
Diffstat (limited to 'doc')
-rw-r--r--doc/server/plugins/generators/packages.txt18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/server/plugins/generators/packages.txt b/doc/server/plugins/generators/packages.txt
index b566b6fbb..701195ba9 100644
--- a/doc/server/plugins/generators/packages.txt
+++ b/doc/server/plugins/generators/packages.txt
@@ -130,12 +130,12 @@ Dependency resolution can be disabled by adding this to
``Packages/packages.conf`` in the ``global`` section::
[global]
- resolver=disabled
+ resolver=0
All metadata processing can be disabled as well::
[global]
- metadata=disabled
+ metadata=0
Blacklisting faulty dependencies
--------------------------------
@@ -638,13 +638,21 @@ packages.conf
=============
``packages.conf`` contains miscellaneous configuration options for the
-Packages plugin. It understands the following directives:
+Packages plugin. Any booleans in the config file accept the values
+"1", "yes", "true", and "on" for True, and "0", "no", "false", and
+"off" for False
+
+It understands the following directives:
[global] section
----------------
-* ``resolver``: Disable dependency resolution. Default is "enabled".
-* ``metadata``: Disable metadata processing. Default is "enabled".
+* ``resolver``: Enable dependency resolution. Default is ``1``
+ (true). For historical reasons, this also accepts "enabled" and
+ "disabled".
+* ``metadata``: Enable metadata processing. Default is ``1``
+ (true). For historical reasons, this also accepts "enabled" and
+ "disabled".
* ``yum_config``: The path at which to generate Yum configs. No
default.
* ``apt_config``: The path at which to generate APT configs. No