From 87c9c0cb2c77fcdeb04d36c17d28c4e7c286a991 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Tue, 16 Feb 2021 15:29:14 -0800 Subject: [PATCH] doc: west: fix incorrect docs related to imports MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- doc/guides/west/manifest.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/guides/west/manifest.rst b/doc/guides/west/manifest.rst index b3acd0ba9c5..42e8e115f65 100644 --- a/doc/guides/west/manifest.rst +++ b/doc/guides/west/manifest.rst @@ -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 ``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 -``P``. Confusingly, the update of ``baz`` may result in the removal of ``P`` -from :file:`baz/west.yml`, which would cause ``west update P`` to fail with an +``P``. Confusingly, updating ``baz`` may result in the removal of ``P`` +from :file:`baz/west.yml`, which "should" cause ``west update P`` to fail with an unrecognized project! -For this reason, it's usually best to run plain ``west update`` to avoid errors -if you use manifest imports. By default, west won't fetch any project data over -the network if a project's 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 -` configuration option for more information. +For this reason, it's not possible to run ``west update P`` if ``P`` is defined +in an imported manifest; you must update this project along with all the others +with a plain ``west update``. + +By default, west won't fetch any project data over the network if a project's +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 ` configuration +option for more information. 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