Skip to content

Commit 1620d29

Browse files
mbolivar-nordiccarlescufi
authored andcommitted
doc: west: add some missing information
There's missing overview documentation for some miscellaneous commands. Add it. Signed-off-by: Marti Bolivar <[email protected]>
1 parent aa066d4 commit 1620d29

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

doc/guides/west/repo-tool.rst

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -244,17 +244,22 @@ Miscellaneous Commands
244244
======================
245245

246246
West has a few more commands for managing the multi-repo, which are briefly
247-
discussed here.
247+
discussed here. Run ``west <command> -h`` for detailed help.
248248

249-
- ``west list``: Lists project information from the manifest (URL, revision,
250-
path, etc.), along with other manifest-related information.
249+
- ``west list [-f FORMAT] [PROJECT ...]``: Lists project information from the
250+
manifest file, such as URL, revision, path, etc. The printed information can
251+
be controlled using the ``-f`` option.
251252

252253
- ``west manifest --freeze [-o outfile]``: Save a "frozen" representation of
253254
the current manifest; all ``revision`` fields are converted to SHAs based on
254255
the current ``manifest-rev`` branches.
255256

257+
- ``west manifest --validate``: Ensure the current manifest file is
258+
well-formed. Print information about what's wrong and fail the process in
259+
case of error.
260+
256261
- ``west diff [PROJECT ...]``: Runs a multi-repo ``git diff``
257-
for the specified projects (default: all cloned projects).
262+
for the specified projects.
258263

259264
- ``west status [PROJECT ...]``: Like ``west diff``, for
260265
running ``git status``.
@@ -268,6 +273,8 @@ discussed here.
268273
forall -c 'git <command> --options'``. Note that ``west forall`` can be used
269274
to run any command, though, not just Git commands.
270275

276+
- ``west help <command>``: this is equivalent to ``west <command> -h``.
277+
271278
.. _PyPI:
272279
https://pypi.org/project/west/
273280

0 commit comments

Comments
 (0)