From 766330ffb6e5e96aec590a6588316c98a49808f0 Mon Sep 17 00:00:00 2001 From: Tristan van Berkom Date: Tue, 8 Dec 2020 15:46:27 +0900 Subject: 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. --- doc/source/format_declaring.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'doc') 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 `. - This field is not permitted in :ref:`Build-Depends ` or - :ref:`Runtime-Depends `. + This field is not permitted in the :ref:`build-depends ` or + :ref:`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 ` + 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 ` + list. + * ``all`` An ``all`` dependency is the default dependency type. If ``all`` is specified, -- cgit v1.2.1