[buildstream] 01/08: doc/source/format_declaring.rst: Minor corrections and added references.

[tv...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tvb pushed a commit to branch tristan/shell-artifacts
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit 39e219e69788e9bcef65fa83a0d6df8b120d6d0d
Author: Tristan van Berkom <tr...@codethink.co.uk>
AuthorDate: Tue Dec 8 15:46:27 2020 +0900

    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(-)

diff --git a/doc/source/format_declaring.rst b/doc/source/format_declaring.rst
index 380f367..1c6a5b3 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,