diff options
| author | Valentin David <valentin.david@codethink.co.uk> | 2018-06-28 15:10:32 +0200 |
|---|---|---|
| committer | Valentin David <valentin.david@codethink.co.uk> | 2018-07-02 16:25:58 +0200 |
| commit | 37b1a77c0fb0c575555956862eeb20caf94fe289 (patch) | |
| tree | 3809631f5f06ac126e88eee6b111f9e03b4eece3 | |
| parent | 4789c0fde87c6d989142c8d6ee473b58f13d38be (diff) | |
| download | buildstream-37b1a77c0fb0c575555956862eeb20caf94fe289.tar.gz | |
doc/source/formatintro.rst: Use references where possible in Include section.
| -rw-r--r-- | doc/source/format_intro.rst | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/doc/source/format_intro.rst b/doc/source/format_intro.rst index d0a934a78..c7b5c14aa 100644 --- a/doc/source/format_intro.rst +++ b/doc/source/format_intro.rst @@ -295,25 +295,26 @@ free form and not validated. Indicates that content should be loaded from files. The include directive expects a list of strings. Those are file names -relative to project directory. Or they can be prefixed with a junction -name and a colon (':'). In that case, the remain of the string is a -file name relative to the project of the junction. +relative to project directory. Or they can be prefixed with a +:mod:`junction <elements.junction>` name and a colon (':'). In that +case, the remain of the string is a file name relative to the project +of the junction. -The include directive can be used in ``project.conf`` or in a ``.bst`` -file. It can also be used in a file included by another include -directive. +The include directive can be used in :ref:`project.conf <projectconf>` +or in a :ref:`.bst <format_basics>` file. It can also be used in a +file included by another include directive. Included files are composed into the including file. The files should -take care of composition using list directives. - -Some ``project.conf`` configuration is not overridable by includes: -``name``, ``format-version`` and ``element-path``. +take care of composition using :ref:`list directives +<format_directives_list_prepend>`. Junction elements never use values from included files from -``project.conf``. Variables, element overrides and source overrides -required by junctions should all be directly in the ``project.conf``. +:ref:`project.conf <projectconf>`. Variables, :ref:`element overrides +<project_element_overrides>` and :ref:`source overrides +<project_source_overrides>` required by junctions should all be +directly in the ref:`project.conf <projectconf>`. -Junction elements cannot use the include directive. +Junction elements cannot use the include directives. **Example:** |