diff options
author | Tristan van Berkom <tristan@codethink.co.uk> | 2020-12-08 15:46:27 +0900 |
---|---|---|
committer | Tristan van Berkom <tristan@codethink.co.uk> | 2020-12-10 21:40:20 +0900 |
commit | 766330ffb6e5e96aec590a6588316c98a49808f0 (patch) | |
tree | ce44692392f3d0006c8b94d8cb1c85190902ec16 | |
parent | ae3344b474b60e2bd93e8e0636e2f56b505f0f73 (diff) | |
download | buildstream-766330ffb6e5e96aec590a6588316c98a49808f0.tar.gz |
doc/source/format_declaring.rst: Minor corrections and added references.
* When documenting dependency types, add references to the shorthand
convenience lists `build-depends` and `runtime-depends`.
* When documenting the `type` attribute of dependencies, correct the
language referring to the convenience lists to specify `build-depends`
and `runtime-depends` instead of the incorrectly worded
`Build-Depends` and `Runtime-Depends`, which would be invalid keys.
-rw-r--r-- | doc/source/format_declaring.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst index 380f367e0..1c6a5b3eb 100644 --- a/doc/source/format_declaring.rst +++ b/doc/source/format_declaring.rst @@ -450,8 +450,8 @@ Attributes: * ``type`` This attribute is used to express the :ref:`dependency type <format_dependencies_types>`. - This field is not permitted in :ref:`Build-Depends <format_build_depends>` or - :ref:`Runtime-Depends <format_runtime_depends>`. + This field is not permitted in the :ref:`build-depends <format_build_depends>` or + :ref:`runtime-depends <format_runtime_depends>` lists. * ``strict`` @@ -540,12 +540,18 @@ There are three types which one can specify for a dependency: which has ``build`` dependencies will not implicitly depend on that element's ``build`` dependencies. + For convenience, these can be specified under the :ref:`build-depends <format_build_depends>` + list. + * ``runtime`` A ``runtime`` dependency type states that the given element's product must be present for the depending element to function. An element's ``runtime`` dependencies are not available to the element at build time. + For convenience, these can be specified under the :ref:`runtime-depends <format_runtime_depends>` + list. + * ``all`` An ``all`` dependency is the default dependency type. If ``all`` is specified, |