Lines Matching refs:west
6 This page describes west's built-in commands, some of which were introduced in
7 :ref:`west-basics`, in more detail.
10 on the entire workspace. For example, ``west diff`` shows local changes in
16 accept them (such as ``west list``, ``west forall``, etc.) usually defaults
20 For additional help, run ``west <command> -h`` (e.g. ``west init -h``).
24 west init
27 This command creates a west workspace. It can be used in two ways:
36 west init [-m URL] [--mr REVISION] [--mf FILE] [directory]
39 :file:`.west` inside this directory. You can give the manifest URL using
47 west init -m https://github.com/zephyrproject-rtos/zephyr --mr v1.14.0 zp
51 :file:`zp/.west`, and set the ``manifest.path`` :ref:`configuration option
52 <west-config>` to ``zephyr`` to record the location of the manifest
56 The ``--mf`` option defaults to ``west.yml``. Since west v0.10.1, west will use
67 west init -l [--mf FILE] directory
69 This creates :file:`.west` **next to** :file:`directory` in the file
72 As above, ``--mf`` defaults to ``west.yml``.
77 ``manifest.file`` using :ref:`west-config-cmd` after running ``west init``.
78 Just be sure to run ``west update`` afterwards to update your workspace to
83 west update
88 west update [-f {always,smart}] [-k] [-r]
94 :file:`west.yml`, and updates each project specified there.
95 If your manifest uses :ref:`project groups <west-manifest-groups>`, then
111 #. Sets the project's :ref:`manifest-rev <west-manifest-rev>` branch to the
116 <west-manifest-submodules>` key for the project, recursively updates
119 To avoid unnecessary fetches, ``west update`` will not fetch project
124 or set the ``update.fetch`` :ref:`configuration option <west-config>` to
129 if the project is tracking a branch), ``west update`` always fetches,
136 For safety, ``west update`` uses ``git checkout --detach`` to check out a
142 ``HEAD`` checked out by west, then git will warn you that you've left
146 branch checked out before running ``west update``.
151 If you would like ``west update`` to keep local branches checked out as
157 ``west update --rebase`` will fail in projects that have git conflicts
163 With a clean working tree, a plain ``west update`` never fails
167 ``west update --keep-descendants`` offers an intermediate option that
172 plain ``west update`` does;
179 are enabled or disabled for the duration of a single ``west update`` command.
180 See :ref:`west-manifest-groups` for details on the project group feature.
182 The ``west update`` command behaves as if the ``--group-filter`` option's
184 :ref:`configuration option <west-config-index>`.
186 For example, running ``west update --group-filter=+foo,-bar`` would behave
188 to the value of ``manifest.group-filter``, run ``west update``, then restored
200 If the project has ``submodules: true``, west first synchronizes the project's
208 whether you run ``west update`` with the ``--rebase`` option or without it:
212 # without --rebase, e.g. "west update":
215 # with --rebase, e.g. "west update --rebase":
219 case, west synchronizes the project's submodules with:
226 run ``west update`` with the ``--rebase`` option or without it:
230 # without --rebase, e.g. "west update":
233 # with --rebase, e.g. "west update --rebase":
237 ``update.sync-submodules`` :ref:`west-config` option is false.
245 workspace, which are summarized here. Run ``west <command> -h`` for
248 - ``west compare``: compare the state of the workspace against the manifest
249 - ``west diff``: run ``git diff`` in local project repositories
250 - ``west forall``: run an arbitrary command in local project repositories
251 - ``west grep``: search for patterns in local project repositories
252 - ``west list``: print a line of information about each project in the
254 - ``west manifest``: manage the manifest file. See :ref:`west-manifest-cmd`.
255 - ``west status``: run ``git status`` in local project repositories
262 - ``west config``: get or set :ref:`configuration options <west-config>`
263 - ``west topdir``: print the top level directory of the west workspace
264 - ``west help``: get help about a command, or print information about all
265 commands in the workspace, including :ref:`west-extensions`