summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim MacArthur <jim.macarthur@codethink.co.uk>2018-03-13 14:47:16 +0000
committerTristan Van Berkom <tristan.van.berkom@gmail.com>2018-03-14 10:51:56 +0000
commit92b04688a41b7306963789519189344950f892b6 (patch)
tree28735c769c2846f1949e4c053091dfee09a5f19e
parentad8bd6f9632aed8ab07a537451fa0479bdae3e31 (diff)
downloadbuildstream-jmac/composition-docs-fix.tar.gz
doc/source/formatintro.rst: Better explanation of defaultsjmac/composition-docs-fix
Users shouldn't see any difference between values hardcoded in Python (if there are any) and the values in projectconfig.yaml, which were previously items 0 and 1 respectively. Combined these both into 1 and made it clear that not all of project.conf is applied right away.
-rw-r--r--doc/source/formatintro.rst25
1 files changed, 12 insertions, 13 deletions
diff --git a/doc/source/formatintro.rst b/doc/source/formatintro.rst
index 427a29597..35cf980bc 100644
--- a/doc/source/formatintro.rst
+++ b/doc/source/formatintro.rst
@@ -62,24 +62,23 @@ Below are the various sources of configuration which go into an element or sourc
order in which they are applied. Configurations which are applied later have a higher
priority and override configurations which precede them.
+1. BuildStream Default Project Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-0. Hard-coded Defaults
-~~~~~~~~~~~~~~~~~~~~~~
-Where a config field is optional, a hard-coded default will
-be present.
-
-
-1. Builtin Default Project Configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The :ref:`projectconf` provides a set of default values for *variables*
-and the *environment* which are all documented with your copy of BuildStream.
+The :ref:`builtin defaults <project_builtin_defaults>` provide a set of default values for *variables*
+and the *environment*.
2. Project Configuration
~~~~~~~~~~~~~~~~~~~~~~~~
-The project wide defaults are now applied on top of builtin defaults. If you specify
-anything in the *variables* or *environment* sections in your ``project.conf`` then it
-will override the builtin defaults.
+
+The project wide defaults in ``project.conf`` are now applied on top
+of builtin defaults. If you specify anything in the *variables* or
+*environment* sections in your ``project.conf`` then it will override
+the builtin defaults.
+
+Note that plugin-specific configuration in ``project.conf`` is not applied
+until later.
3. Plugin Defaults