michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: add some missing information

Browse source 
There's missing overview documentation for some miscellaneous
commands. Add it.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Marti Bolivar 2019-08-28 14:06:45 -06:00 • committed by Carles Cufí
commit 1620d29ba6
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/guides/west/repo-tool.rst
View file

@ -244,17 +244,22 @@ Miscellaneous Commands
====================== ======================
West has a few more commands for managing the multi-repo, which are briefly West has a few more commands for managing the multi-repo, which are briefly
discussed here. discussed here. Run ``west <command> -h`` for detailed help.
- ``west list``: Lists project information from the manifest (URL, revision, - ``west list [-f FORMAT] [PROJECT ...]``: Lists project information from the
path, etc.), along with other manifest-related information. manifest file, such as URL, revision, path, etc. The printed information can
be controlled using the ``-f`` option.
- ``west manifest --freeze [-o outfile]``: Save a "frozen" representation of - ``west manifest --freeze [-o outfile]``: Save a "frozen" representation of
the current manifest; all ``revision`` fields are converted to SHAs based on the current manifest; all ``revision`` fields are converted to SHAs based on
the current ``manifest-rev`` branches. the current ``manifest-rev`` branches.
- ``west manifest --validate``: Ensure the current manifest file is
well-formed. Print information about what's wrong and fail the process in
case of error.
- ``west diff [PROJECT ...]``: Runs a multi-repo ``git diff`` - ``west diff [PROJECT ...]``: Runs a multi-repo ``git diff``
for the specified projects (default: all cloned projects). for the specified projects.
- ``west status [PROJECT ...]``: Like ``west diff``, for - ``west status [PROJECT ...]``: Like ``west diff``, for
running ``git status``. running ``git status``.
@ -268,6 +273,8 @@ discussed here.
forall -c 'git <command> --options'``. Note that ``west forall`` can be used forall -c 'git <command> --options'``. Note that ``west forall`` can be used
to run any command, though, not just Git commands. to run any command, though, not just Git commands.
- ``west help <command>``: this is equivalent to ``west <command> -h``.
.. _PyPI: .. _PyPI:
https://pypi.org/project/west/ https://pypi.org/project/west/