michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: submodule 'name' is optional after west 0.9.0

Browse source 
See west commit 02444d058335

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
This commit is contained in:
Marc Herbert 2021-02-09 01:11:51 +00:00 • committed by Carles Cufí
commit 0d8a2bc820
2 changed files with 31 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1015,10 +1015,16 @@ Here, ``west update`` will initialize and update all submodules in ``foo``. If
Option 2: List of mappings Option 2: List of mappings
========================== ==========================
The ``submodules`` key may be a list of mappings. Each element in the list The ``submodules`` key may be a list of mappings, one list element for
defines the name of the submodule to update, and the path -- relative to the each desired submodule. Each submodule listed is updated recursively.
project's absolute path in the workspace -- to use for the submodule. You can still track and update unlisted submodules with ``git`` commands
The submodule will be updated recursively. manually; present or not they will be completely ignored by ``west``.
The ``path`` key must match exactly the path of one submodule relative
to its parent west project, as shown in the output of ``git submodule
status``. The ``name`` key is optional and not used by west for now;
it's not passed to ``git submodule`` commands either. The ``name`` key
was briefly mandatory in west version 0.9.0, but was made optional in 0.9.1.
For example, let's say you have a source code repository ``foo``, which has For example, let's say you have a source code repository ``foo``, which has
many submodules, and you want ``west update`` to keep some but not all of them many submodules, and you want ``west update`` to keep some but not all of them
@ -1032,8 +1038,7 @@ You can do that with this manifest file:
projects: projects:
- name: foo - name: foo
submodules: submodules:
- name: foo-first-sub - path: path/to/foo-first-sub
path: path/to/foo-first-sub
- name: foo-second-sub - name: foo-second-sub
path: path/to/foo-second-sub path: path/to/foo-second-sub
- name: bar - name: bar

20
doc/guides/west/release-notes.rst
View file

@ -1,6 +1,20 @@
West Release Notes West Release Notes
################## ##################
v0.10.0
*******
New features:
- A manifest file's ``group-filter`` is now propagated through an ``import``.
This is a change from how west v0.9.x handled this. In west v0.9.x, only the
top level manifest file's ``group-filter`` had any effect; the group filter
lists from any imported manifests were ignored. Starting with west v0.10.0,
the group filter lists from imported manifests are also imported. For
details, see :ref:`west-group-filter-imports`.
- The ``name`` key in a project's submodules list is now optional.
v0.9.0 v0.9.0
****** ******
@ -10,6 +24,12 @@ v0.9.0
other manual edits in configuration files will be removed when setting a other manual edits in configuration files will be removed when setting a
configuration option via that command or the ``west.configuration`` API. configuration option via that command or the ``west.configuration`` API.
.. warning::
Combining the ``group-filter`` feature introduced in this release with
manifest imports is discouraged. The resulting behavior has changed in west
v0.10.
New features: New features:
- West manifests now support :ref:`west-manifest-submodules`. This allows you - West manifests now support :ref:`west-manifest-submodules`. This allows you