michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: fix incorrect docs related to imports

Browse source 
The documentation suggests that 'west update PROJECT' can be done if
PROJECT is defined from some imported manifest. That's actually not
true. Fix it.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2021-02-16 15:29:14 -08:00 • committed by Carles Cufí
commit 87c9c0cb2c
1 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1713,16 +1713,19 @@ which defines a project ``P``, must be up to date in order for west to update
``P`` itself. For example, this means ``west update P`` would update ``P`` itself. For example, this means ``west update P`` would update
``manifest-rev`` in the ``baz`` project if :file:`baz/west.yml` defines ``P``, ``manifest-rev`` in the ``baz`` project if :file:`baz/west.yml` defines ``P``,
as well as updating the ``manifest-rev`` branch in the local git clone of as well as updating the ``manifest-rev`` branch in the local git clone of
``P``. Confusingly, the update of ``baz`` may result in the removal of ``P`` ``P``. Confusingly, updating ``baz`` may result in the removal of ``P``
from :file:`baz/west.yml`, which would cause ``west update P`` to fail with an from :file:`baz/west.yml`, which "should" cause ``west update P`` to fail with an
unrecognized project! unrecognized project!
For this reason, it's usually best to run plain ``west update`` to avoid errors For this reason, it's not possible to run ``west update P`` if ``P`` is defined
if you use manifest imports. By default, west won't fetch any project data over in an imported manifest; you must update this project along with all the others
the network if a project's revision is a SHA or tag which is already available with a plain ``west update``.
locally, so updating the extra projects shouldn't take too much time unless
it's really needed. See the documentation for the :ref:`update.fetch By default, west won't fetch any project data over the network if a project's
<west-config-index>` configuration option for more information. revision is a SHA or tag which is already available locally, so updating the
extra projects shouldn't take too much time unless it's really needed. See the
documentation for the :ref:`update.fetch <west-config-index>` configuration
option for more information.
If an imported manifest file has a ``west-commands:`` definition in its If an imported manifest file has a ``west-commands:`` definition in its
``self:`` section, the extension commands defined there are added to the set of ``self:`` section, the extension commands defined there are added to the set of