Skip to content

Commit 7097e17

Browse files
mbolivar-nordiccarlescufi
authored andcommitted
doc: improve west's repo-tool.rst
Various improvements to the west repo-tool.rst page and pages that link to it: Rename the page title to "Basics", since it documents, well the basics, including built-in commands like "help" an "config" that are not directly related to multiple repositories. The "multi-repo" term was invented before we started using "workspace". Drop it from the text and rework things using words like "workspace", "basics", or "built-ins" instead, which read better. We've been using west for a long enough time that justifying its existence prominently at the start of this page is no longer necessary; move that to the "dustbin of history" page (why.rst). Try harder to clarify exactly what a "project" is, along with other workspace related clarifications. Improve the documentation for the west init and west update commands, and create :ref: targets for linking directly to them for convenience elsewhere in the docs. Slim down the usages for other built-in commands, so we don't have to keep those up to date as carefully each release. This is about to be important for west 0.9, which is going to change the detailed semantics for the "[PROJECT ...]" part of each command synopsis in a way that will be inconvenient to duplicate for each of these. Move the "Topologies supported" content lower down. Try to help the reading flow by letting people get familiar with a workspace and what you can do with it using the Zephyr GSG workspace that they probably already have before overwhelming them with other possibilities and choices. Signed-off-by: Martí Bolívar <[email protected]>
1 parent 476e9e8 commit 7097e17

File tree

4 files changed

+270
-206
lines changed

4 files changed

+270
-206
lines changed

doc/guides/west/config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ commands are documented in the pages for those commands.
142142
* - ``update.fetch``
143143
- String, one of ``"smart"`` (the default behavior starting in v0.6.1) or
144144
``"always"`` (the previous behavior). If set to ``"smart"``, the
145-
:ref:`west update <west-multi-repo-cmds>` command will skip fetching
145+
:ref:`west-update` command will skip fetching
146146
from project remotes when those projects' revisions in the manifest file
147147
are SHAs or tags which are already available locally. The ``"always"``
148148
behavior is to unconditionally fetch from the remote.

doc/guides/west/release-notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ v0.6.1
149149

150150
The user-visible features in this point release are:
151151

152-
- The `west update <west-multi-repo-cmds>` command has a new ``--fetch``
152+
- The :ref:`west-update` command has a new ``--fetch``
153153
command line flag and ``update.fetch`` :ref:`configuration option
154154
<west-config>`. The default value, "smart", skips fetching SHAs and tags
155155
which are available locally.

0 commit comments

Comments
 (0)