michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: projects list is optional in v0.10

Browse source 
Document this fact.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2021-03-01 11:43:09 -08:00 • committed by Carles Cufí
commit 86990a7d9e
1 changed files with 12 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/guides/west/manifest.rst
View file

@ -81,17 +81,17 @@ with some subsections, like this:
manifest: manifest:
remotes: remotes:
# short names for project URLs (optional) # short names for project URLs
projects: projects:
# a list of projects managed by west (mandatory) # a list of projects managed by west
defaults: defaults:
# default project attributes (optional) # default project attributes
self: self:
# configuration related to the manifest repository itself, # configuration related to the manifest repository itself,
# i.e. the repository containing west.yml (optional) # i.e. the repository containing west.yml
version: <schema-version> # optional version: <schema-version>
group-filter: group-filter:
# a list of project groups to enable or disable (optional) # a list of project groups to enable or disable
In YAML terms, the manifest file contains a mapping, with a ``manifest`` In YAML terms, the manifest file contains a mapping, with a ``manifest``
key. Any other keys and their contents are ignored (west v0.5 also required a key. Any other keys and their contents are ignored (west v0.5 also required a
@ -99,8 +99,12 @@ key. Any other keys and their contents are ignored (west v0.5 also required a
The manifest contains subsections, like ``defaults``, ``remotes``, The manifest contains subsections, like ``defaults``, ``remotes``,
``projects``, and ``self``. In YAML terms, the value of the ``manifest`` key is ``projects``, and ``self``. In YAML terms, the value of the ``manifest`` key is
also a mapping, with these "subsections" as keys. Only ``projects`` is also a mapping, with these "subsections" as keys. As of west v0.10, all of
mandatory: this is the list of repositories managed by west and their metadata. these "subsection" keys are optional.
The ``projects`` value is a list of repositories managed by west and associated
metadata. We'll discuss it soon, but first we will describe the ``remotes``
section, which can be used to save typing in the ``projects`` list.
Remotes Remotes
======= =======