summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-04-05 20:52:21 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-04-05 22:11:58 +0900
commit22fe6b74c690b7bdebf65215a4db493abf723eaa (patch)
tree2190a09c4aa6e63e99564f7b02bc2c90e267045d /doc/source
parent34210d1e99d43358ddb9e683f476995137f67226 (diff)
downloadbuildstream-22fe6b74c690b7bdebf65215a4db493abf723eaa.tar.gz
doc/source/projectrefs.rst: Ammended documentation for project.refs
This was missing the main `projects` toplevel key
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/projectrefs.rst47
1 files changed, 25 insertions, 22 deletions
diff --git a/doc/source/projectrefs.rst b/doc/source/projectrefs.rst
index 12d722d7e..a312792b8 100644
--- a/doc/source/projectrefs.rst
+++ b/doc/source/projectrefs.rst
@@ -48,25 +48,28 @@ a list of dictionaries corresponding to the element's :ref:`sources <format_sour
.. code:: yaml
- # The local project's name is "core"
- core:
-
- # A dictionary of element names
- base/automake.bst:
-
- # A list of sources corresponding to the element
- # in the same order in which they were declared.
- #
- # The values of this list are dictionaries of the
- # symbolic "ref" portion understood by the given
- # source plugin implementation.
- #
- - ref: af6ba39142220687c500f79b4aa2f181d9b24e4...
-
- # The "core" project depends on the "bootstrap" project,
- # here we are allowed to override the refs for the projects
- # we depend on through junctions.
- bootstrap:
-
- zlib.bst:
- - ref: 4ff941449631ace0d4d203e3483be9dbc9da4540...
+ # Main toplevel "projects" key
+ projects:
+
+ # The local project's name is "core"
+ core:
+
+ # A dictionary of element names
+ base/automake.bst:
+
+ # A list of sources corresponding to the element
+ # in the same order in which they were declared.
+ #
+ # The values of this list are dictionaries of the
+ # symbolic "ref" portion understood by the given
+ # source plugin implementation.
+ #
+ - ref: af6ba39142220687c500f79b4aa2f181d9b24e4...
+
+ # The "core" project depends on the "bootstrap" project,
+ # here we are allowed to override the refs for the projects
+ # we depend on through junctions.
+ bootstrap:
+
+ zlib.bst:
+ - ref: 4ff941449631ace0d4d203e3483be9dbc9da4540...