Lines Matching refs:west
6 This page introduces west's basic concepts and provides references to further
9 West's built-in commands allow you to work with :term:`projects <west project>`
10 (Git repositories) under a common :term:`workspace <west workspace>` directory.
12 West works in the following manner: the ``west init`` command creates the
13 :term:`west workspace`, and clones the :term:`manifest repo <west manifest
14 repository>`, while the ``west update`` command initially clones, and later updates, the
15 :term:`projects <west project>` listed in the manifest in the workspace.
21 :term:`west workspace`, which in this case is the folder named
26 zephyrproject/ # west topdir
27 ├── .west/ # marks the location of the topdir
30 │ # The manifest repository, never modified by west after creation:
32 │ ├── west.yml # manifest file
35 │ # Projects managed by west:
49 Additional details are in :ref:`west-workspaces`.
57 using :ref:`west init <west-init-basics>`.
59 .west directory
60 The topdir contains the :file:`.west` directory. When west needs to find
61 the topdir, it searches for :file:`.west`, and uses its parent directory.
67 The file :file:`.west/config` is the workspace's :ref:`local configuration
68 file <west-config>`.
71 Every west workspace contains exactly one *manifest repository*, which is a
74 <west-config-index>` in the local configuration file.
77 configure west to use any Git repository in the workspace as the manifest
79 See :ref:`west-topologies` for information on other options, and
80 :ref:`west-manifests` for details on the manifest file format.
84 additional Git repositories in the workspace managed by west. The manifest
85 file is named :file:`west.yml` by default; this can be overridden using the
88 You use the :ref:`west update <west-update-basics>` command to update the
92 Projects are Git repositories managed by west. Projects are defined in the
96 By default, the Zephyr :ref:`build system <build_overview>` uses west to get
102 Any repository known to west (either the manifest repository or any project
103 repository) can define :ref:`west-extensions`. Extensions are extra west
107 like :ref:`west build <west-building>`. Defining these as extensions keeps
108 west's core agnostic to the specifics of any workspace's Zephyr version,
113 directories not managed by west. West basically ignores anything in the
114 workspace except :file:`.west`, the manifest repository, and the projects
117 west init and west update
120 The two most important workspace-related commands are ``west init`` and ``west
125 ``west init`` basics
128 This command creates a west workspace.
132 West doesn't change your manifest repository contents after ``west init`` is
139 west init -m https://github.com/zephyrproject-rtos/zephyr --mr v2.5.0 zephyrproject
144 :file:`.west` and :file:`.west/config` inside it
149 #. Set ``manifest.path`` to ``zephyr`` in :file:`.west/config`
150 #. Set ``manifest.file`` to ``west.yml``
152 Your workspace is now almost ready to use; you just need to run ``west update``
155 For more details, see :ref:`west-init`.
159 ``west update`` basics
168 should run ``west update`` to make sure your workspace contains the
171 The ``west update`` command reads the manifest file's contents by:
173 #. Finding the topdir. In the ``west init`` example above, that
175 #. Loading :file:`.west/config` in the topdir to read the ``manifest.path``
176 (e.g. ``zephyr``) and ``manifest.file`` (e.g. ``west.yml``) options.
178 :file:`zephyrproject/zephyr/west.yml`).
186 For more details, see :ref:`west-update`.
191 See :ref:`west-built-in-cmds`.
200 - :ref:`west-build-flash-debug`
201 - :ref:`west-sign`
202 - :ref:`west-zephyr-ext-cmds`
203 - :ref:`west-shell-completion`
208 See :ref:`west-troubleshooting`.