Lines Matching +full:manifest +full:- +full:path
1 .. _west-config:
7 command, and configuration options used by built-in commands. For API
9 :ref:`west-apis-configuration`.
12 ------------------------
14 West's configuration file syntax is INI-like; here is an example file:
16 .. code-block:: ini
18 [manifest]
19 path = zephyr
24 Above, the ``manifest`` section has option ``path`` set to ``zephyr``. Another
25 way to say the same thing is that ``manifest.path`` is ``zephyr`` in this file.
32 - Linux: :file:`/etc/westconfig`
33 - macOS: :file:`/usr/local/etc/westconfig`
34 - Windows: :file:`%PROGRAMDATA%\\west\\config`
39 - All platforms: the default is :file:`.westconfig` in the user's home
41 - Linux note: if the environment variable :envvar:`XDG_CONFIG_HOME` is set,
43 - Windows note: the following environment variables are tested to find the
57 .. _west-config-cmd:
60 -----------
62 The built-in ``config`` command can be used to get and set configuration
63 values. You can pass ``west config`` the options ``--system``, ``--global``, or
64 ``--local`` to specify which configuration file to use. Only one of these can
65 be used at a time. If none is given, then writes default to ``--local``, and
68 Some examples for common uses follow; run ``west config -h`` for detailed help,
69 and see :ref:`west-config-index` for more details on built-in options.
71 To set ``manifest.path`` to :file:`some-other-manifest`:
73 .. code-block:: console
75 west config manifest.path some-other-manifest
78 :term:`west manifest` inside the :file:`some-other-manifest` directory
85 .. code-block:: console
89 You can switch to another zephyr repository without changing ``manifest.path``
90 -- and thus the behavior of commands like ``west update`` -- using:
92 .. code-block:: console
94 west config zephyr.base some-other-zephyr
98 of the zephyr repository specified in the manifest. (You can go back to using
99 the directory in the upstream manifest by running ``west config zephyr.base
102 To set ``color.ui`` to ``false`` in the global (user-wide) configuration file,
106 .. code-block:: console
108 west config --global color.ui false
112 .. code-block:: console
114 west config --global color.ui true
116 .. _west-config-index:
118 Built-in Configuration Options
119 ------------------------------
122 built-in commands. Configuration options supported by Zephyr's extension
127 .. list-table::
129 :header-rows: 1
131 * - Option
132 - Description
133 * - ``color.ui``
134 - Boolean. If ``true`` (the default), then west output is colorized when
136 * - ``commands.allow_extensions``
137 - Boolean, default ``true``, disables :ref:`west-extensions` if ``false``
138 * - ``manifest.file``
139 - String, default ``west.yml``. Relative path from the manifest repository
140 root directory to the manifest file used by ``west init`` and other
141 commands which parse the manifest.
142 * - ``manifest.group-filter``
143 - String, default empty. A comma-separated list of project groups to
145 ``+`` and disabled groups with ``-``. For example, the value
146 ``"+foo,-bar"`` enables group ``foo`` and disables ``bar``. See
147 :ref:`west-manifest-groups`.
148 * - ``manifest.path``
149 - String, relative path from the :term:`west workspace` root directory
150 to the manifest repository used by ``west update`` and other commands
151 which parse the manifest. Set locally by ``west init``.
152 * - ``update.fetch``
153 - String, one of ``"smart"`` (the default behavior starting in v0.6.1) or
155 :ref:`west-update` command will skip fetching
156 from project remotes when those projects' revisions in the manifest file
159 * - ``update.name-cache``
160 - String. If non-empty, ``west update`` will use its value as the
161 ``--name-cache`` option's value if not given on the command line.
162 * - ``update.narrow``
163 - Boolean. If ``true``, ``west update`` behaves as if ``--narrow`` was
165 * - ``update.path-cache``
166 - String. If non-empty, ``west update`` will use its value as the
167 ``--path-cache`` option's value if not given on the command line.
168 * - ``update.sync-submodules``
169 - Boolean. If ``true`` (the default), :ref:`west-update` will synchronize
171 * - ``zephyr.base``
172 - String, default value to set for the :envvar:`ZEPHYR_BASE` environment
174 the path to the manifest project with path :file:`zephyr` (if there is
176 setting is ignored unless ``zephyr.base-prefer`` is ``"configfile"``.
177 * - ``zephyr.base-prefer``
178 - String, one the values ``"env"`` and ``"configfile"``. If set to