diff options
| author | Tristan van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-08-06 21:29:09 +0900 |
|---|---|---|
| committer | bst-marge-bot <marge-bot@buildstream.build> | 2020-08-10 08:33:55 +0000 |
| commit | 83cff41bc0616db68a90088700c4984a110a16f0 (patch) | |
| tree | 2e479e97d7fb31a43a04d52c32aa196e345db38d /doc | |
| parent | 89a1c1b7e5c192f52779aa2b7f41b0d6df88e509 (diff) | |
| download | buildstream-83cff41bc0616db68a90088700c4984a110a16f0.tar.gz | |
doc/source/format_project.rst: Documenting keys which must be in project.conf
Clarify the few keys which must absolutely be declared in project.conf
if declared at all, these keys cannot be declared in a separate include
file.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/format_project.rst | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/source/format_project.rst b/doc/source/format_project.rst index ffec5e176..0216e524a 100644 --- a/doc/source/format_project.rst +++ b/doc/source/format_project.rst @@ -36,10 +36,13 @@ of your project. name: my-project-name -.. note:: +The project name may contain alphanumeric characters, dashes and +underscores, and may not start with a leading digit. - The project name may contain alphanumeric characters, dashes and - underscores, and may not start with a leading digit. +.. attention:: + + The project name must be specified in the ``project.conf`` and + cannot be :ref:`included <format_directives_include>` from a separate file. .. _project_min_version: @@ -78,6 +81,11 @@ it has been there from the beginning. plugins also implement their own YAML configuration fragments and as such are revisioned separately from the core format. +.. attention:: + + The ``min-version`` must be specified in the ``project.conf`` and + cannot be :ref:`included <format_directives_include>` from a separate file. + .. _project_element_path: @@ -94,6 +102,11 @@ allows the user to specify a project subdirectory where element Note that elements are referred to by their relative paths, whenever elements are referred to in a ``.bst`` file or on the command line. +.. attention:: + + The ``element-path`` can only be specified in the ``project.conf`` and + cannot be :ref:`included <format_directives_include>` from a separate file. + .. _project_format_ref_storage: @@ -383,6 +396,11 @@ of the plugins it means to make use of and the origin from which they can be loa Note that plugins with the same name from different origins are not permitted. +.. attention:: + + The plugins can only be specified in the ``project.conf`` and cannot be + :ref:`included <format_directives_include>` from a separate file. + .. _project_plugins_local: |