Explictly document the configuration override priority

This commit is contained in:
Erik Johnson 2018-08-02 11:19:22 -05:00
parent d4bb3a0963
commit 7dce7cde14
No known key found for this signature in database
GPG key ID: 5E5583C437808F3F
2 changed files with 32 additions and 1 deletions

View file

@ -5054,6 +5054,21 @@ https://github.com/ytoolshed/range/wiki/%22yamlfile%22-module-file-spec
Include Configuration
=====================
Configuration can be loaded from multiple files. The order in which this is
done is:
1. The master config file itself
2. The files matching the glob in :conf_master:`default_include`
3. The files matching the glob in :conf_master:`include` (if defined)
Each successive step overrides any values defined in the previous steps.
Therefore, any config options defined in one of the
:conf_master:`default_include` files would override the same value in the
master config file, and any options defined in :conf_master:`include` would
override both.
.. conf_master:: default_include
``default_include``

View file

@ -2928,7 +2928,22 @@ at the moment a single state fails
Include Configuration
=====================
.. conf_minion:: include
Configuration can be loaded from multiple files. The order in which this is
done is:
1. The minion config file itself
2. The files matching the glob in :conf_minion:`default_include`
3. The files matching the glob in :conf_minion:`include` (if defined)
Each successive step overrides any values defined in the previous steps.
Therefore, any config options defined in one of the
:conf_minion:`default_include` files would override the same value in the
minion config file, and any options defined in :conf_minion:`include` would
override both.
.. conf_minion:: default_include
``default_include``
-------------------
@ -2946,6 +2961,7 @@ file.
files are prefixed with an underscore. A common example of this is the
``_schedule.conf`` file.
.. conf_minion:: include
``include``
-----------