diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-03 18:55:54 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-05-03 18:55:54 +0900 |
| commit | d0413e4e17564fea0b31379dc905e1638ca07ad2 (patch) | |
| tree | b1fccd017527a5d9634e611670472d681d2f1c67 /doc/source/format.rst | |
| parent | 72fe2ce5142fddc33ca2e2cc6a1e35bc0a9782c4 (diff) | |
| download | buildstream-d0413e4e17564fea0b31379dc905e1638ca07ad2.tar.gz | |
Documentation: Added user facing project configuration section
Instead of documenting this in the Project object, provide a section
more targetted at users. The default configuration is shown in the
user facing documentation and removed from the Project object documentation
which is more targetted at API references for plugin authors.
References to the Project Configuration from the format documentation
have been updated to refer to this new section.
Diffstat (limited to 'doc/source/format.rst')
| -rw-r--r-- | doc/source/format.rst | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/source/format.rst b/doc/source/format.rst index 76e94b2d0..775a725ca 100644 --- a/doc/source/format.rst +++ b/doc/source/format.rst @@ -34,7 +34,7 @@ A typical project structure may look like this:: Except for the project configuration file, the user is allowed to structure their project directory in any way. For documentation on the format of the project -configuration file, refer to the :mod:`Project <buildstream.project>` documentation. +configuration file, refer to the :ref:`projectconf` documentation. Simpler projects may choose to place all element definition files at the root of the project directory while more complex projects may decide to @@ -54,7 +54,7 @@ and override configurations which precede them. 1. Builtin Defaults ~~~~~~~~~~~~~~~~~~~ -The :mod:`Project <buildstream.project>` provides a set of default values for *variables* +The :ref:`projectconf` provides a set of default values for *variables* and the *environment* which are all documented with your copy of BuildStream. @@ -223,7 +223,7 @@ Variables sysconfdir: "%{prefix}/etc" Variables can be declared or overridden from an element. Variables can also be -declared and overridden in the :mod:`Project Configuration <buildstream.project>` +declared and overridden in the :ref:`projectconf` See `Using Variables`_ below for a more in depth discussion on variables in BuildStream. @@ -242,8 +242,7 @@ variables will be effective in the :mod:`Sandbox <buildstream.sandbox>` where build instructions are run for this element. -Environment variables can also be -declared and overridden in the :mod:`Project Configuration <buildstream.project>` +Environment variables can also be declared and overridden in the :ref:`projectconf` Config |