Skip to content

Commit 1dafe7a

Browse files
mbolivar-nordicgalak
authored andcommitted
doc: west: move manifest command docs to manifest.rst
This is just a prep work commit for documenting ``west manifest --merge``. Signed-off-by: Martí Bolívar <[email protected]>
1 parent 55a10fe commit 1dafe7a

File tree

2 files changed

+31
-7
lines changed

2 files changed

+31
-7
lines changed

doc/guides/west/manifest.rst

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
West Manifests
44
##############
55

6-
This page contains detailed information about west's multiple repository model
7-
and manifest files. For API documentation on the ``west.manifest`` module, see
8-
:ref:`west-apis-manifest`. For a more general introduction and command
9-
overview, see :ref:`west-multi-repo`.
6+
This page contains detailed information about west's multiple repository model,
7+
manifest files, and the ``west manifest`` command. For API documentation on the
8+
``west.manifest`` module, see :ref:`west-apis-manifest`. For a more general
9+
introduction and command overview, see :ref:`west-multi-repo`.
1010

1111
.. _west-mr-model:
1212

@@ -271,3 +271,29 @@ repository root.
271271

272272
The pykwalify schema :file:`manifest-schema.yml` in the west source code
273273
repository is used to validate the manifest section.
274+
275+
.. _west-manifest-cmd:
276+
277+
Manifest Command
278+
****************
279+
280+
The ``west manifest`` command can be used to manipulate manifest files.
281+
It takes an action, and action-specific arguments.
282+
283+
The following sections describe each action and provides a basic signature for
284+
simple uses. Run ``west manifest --help`` for full details on all options.
285+
286+
Freezing Manifests
287+
==================
288+
289+
The ``--freeze`` action outputs a frozen manifest:
290+
291+
.. code-block:: none
292+
293+
west manifest --freeze [-o outfile]
294+
295+
A "frozen" manifest is a manifest file where every project's revision is a SHA.
296+
You can use ``--freeze`` to produce a frozen manifest that's equivalent to your
297+
current manifest file. The ``-o`` option specifies an output file; if not
298+
given, standard output is used.
299+

doc/guides/west/repo-tool.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -266,9 +266,7 @@ discussed here. Run ``west <command> -h`` for detailed help.
266266
manifest file, such as URL, revision, path, etc. The printed information can
267267
be controlled using the ``-f`` option.
268268

269-
- ``west manifest --freeze [-o outfile]``: Save a "frozen" representation of
270-
the current manifest; all ``revision`` fields are converted to SHAs based on
271-
the current ``manifest-rev`` branches.
269+
- ``west manifest``: Manipulates manifest files. See :ref:`west-manifest-cmd`.
272270

273271
- ``west manifest --validate``: Ensure the current manifest file is
274272
well-formed. Print information about what's wrong and fail the process in

0 commit comments

Comments
 (0)