Lines Matching +full:manifest +full:- +full:path
1 .. _west-basics:
9 West's built-in commands allow you to work with *projects* (Git
18 .. code-block:: none
22 │ └── config # per-workspace local configuration file
24 │ # The manifest repository, never modified by west after creation:
26 │ ├── west.yml # manifest file
33 ├── net-tools/ # .git/ project
36 .. _west-workspace:
42 Additional details are in :ref:`west-workspaces`.
47 -- it could be anything, like ``z``, ``my-zephyr-workspace``, etc.)
50 using :ref:`west init <west-init-basics>`.
61 file <west-config>`.
63 manifest repository
64 Every west workspace contains exactly one *manifest repository*, which is a
65 Git repository containing a *manifest file*. The location of the manifest
66 repository is given by the :ref:`manifest.path configuration option
67 <west-config-index>` in the local configuration file.
69 For upstream Zephyr, :file:`zephyr` is the manifest repository, but you can
70 configure west to use any Git repository in the workspace as the manifest
71 repository. The only requirement is that it contains a valid manifest file.
72 See :ref:`west-topologies` for information on other options, and
73 :ref:`west-manifests` for details on the manifest file format.
75 manifest file
76 The manifest file is a YAML file that defines *projects*, which are the
77 additional Git repositories in the workspace managed by west. The manifest
79 ``manifest.file`` local configuration option.
81 You use the :ref:`west update <west-update-basics>` command to update the
82 workspace's projects based on the contents of the manifest file.
86 manifest file and can be located anywhere inside the workspace. In the above
87 example workspace, ``tinycbor`` and ``net-tools`` are projects.
94 Any repository known to west (either the manifest repository or any project
95 repository) can define :ref:`west-extensions`. Extensions are extra west
98 The zephyr repository uses this feature to provide Zephyr-specific commands
99 like :ref:`west build <west-building>`. Defining these as extensions keeps
106 workspace except :file:`.west`, the manifest repository, and the projects
107 specified in the manifest file.
112 The two most important workspace-related commands are ``west init`` and ``west
115 .. _west-init-basics:
118 --------------------
124 West doesn't change your manifest repository contents after ``west init`` is
129 .. code-block:: shell
131 west init -m https://github.com/zephyrproject-rtos/zephyr --mr v2.5.0 zephyrproject
137 #. Clone the manifest repository from
138 https://github.com/zephyrproject-rtos/zephyr, placing it into
141 #. Set ``manifest.path`` to ``zephyr`` in :file:`.west/config`
142 #. Set ``manifest.file`` to ``west.yml``
147 For more details, see :ref:`west-init`.
149 .. _west-update-basics:
152 ----------------------
155 projects in the manifest file.
159 Whenever you check out a different revision in your manifest repository, you
163 The ``west update`` command reads the manifest file's contents by:
167 #. Loading :file:`.west/config` in the topdir to read the ``manifest.path``
168 (e.g. ``zephyr``) and ``manifest.file`` (e.g. ``west.yml``) options.
169 #. Loading the manifest file given by these options (e.g.
172 It then uses the manifest file to decide where missing projects should be
176 revisions in the manifest file.
178 For more details, see :ref:`west-update`.
180 Other built-in commands
183 See :ref:`west-built-in-cmds`.
185 .. _west-zephyr-extensions:
192 - :ref:`west-build-flash-debug`
193 - :ref:`west-sign`
194 - :ref:`west-zephyr-ext-cmds`
195 - :ref:`west-shell-completion`
200 See :ref:`west-troubleshooting`.