Lines Matching +full:- +full:- +full:update
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
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 ``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
77 Doing the above means that commands like ``west update`` will look for the
78 :term:`west manifest` inside the :file:`some-other-manifest` directory
85 .. code-block:: console
90 -- and thus the behavior of commands like ``west update`` -- using:
92 .. code-block:: console
94 west config zephyr.base some-other-zephyr
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 * - :samp:`alias.{ALIAS}`
134 - String. If non-empty the ``<ALIAS>`` can be used as a west command.
135 See :ref:`west-aliases`.
136 * - ``color.ui``
137 - Boolean. If ``true`` (the default), then west output is colorized when
139 * - ``commands.allow_extensions``
140 - Boolean, default ``true``, disables :ref:`west-extensions` if ``false``
141 * - ``grep.color``
142 - String, default empty. Set this to ``never`` to disable ``west grep``
144 ``--color`` option.
145 * - ``grep.tool``
146 - String, one of ``"git-grep"`` (default), ``"ripgrep"``, or ``"grep"``.
148 * - ``grep.<TOOL>-args``
149 - String, default empty. The ``<TOOL>`` part is a pattern that can be any
150 ``grep.tool`` value, so ``grep.ripgrep-args`` is an example
153 * - ``grep.<TOOL>-path``
154 - String, default empty. The ``<TOOL>`` part is a pattern that can be any
155 ``grep.tool`` value, so ``grep.ripgrep-path`` is an example
159 * - ``manifest.file``
160 - String, default ``west.yml``. Relative path from the manifest repository
163 * - ``manifest.group-filter``
164 - String, default empty. A comma-separated list of project groups to
166 ``+`` and disabled groups with ``-``. For example, the value
167 ``"+foo,-bar"`` enables group ``foo`` and disables ``bar``. See
168 :ref:`west-manifest-groups`.
169 * - ``manifest.path``
170 - String, relative path from the :term:`west workspace` root directory
171 to the manifest repository used by ``west update`` and other commands
173 * - ``manifest.project-filter``
174 - Comma-separated list of strings.
176 The option's value is a comma-separated list of regular expressions,
177 each prefixed with ``+`` or ``-``, like this:
179 .. code-block:: none
181 +re1,-re2,-re3
187 element begins with ``-``. The project is activated if the element
194 if ``manifest.project-filter`` is:
196 .. code-block:: none
198 -hal_.*,+hal_foo
210 to its groups (see :ref:`west-project-group-examples` for examples in
213 Within an element of a ``manifest.project-filter`` list, leading and
217 .. code-block:: none
219 +foo,-bar
220 +foo , -bar
225 .. code-block:: none
227 +foo,,-bar
228 +foo,-bar
230 * - ``update.fetch``
231 - String, one of ``"smart"`` (the default behavior starting in v0.6.1) or
233 :ref:`west-update` command will skip fetching
237 * - ``update.name-cache``
238 - String. If non-empty, ``west update`` will use its value as the
239 ``--name-cache`` option's value if not given on the command line.
240 * - ``update.narrow``
241 - Boolean. If ``true``, ``west update`` behaves as if ``--narrow`` was
243 * - ``update.path-cache``
244 - String. If non-empty, ``west update`` will use its value as the
245 ``--path-cache`` option's value if not given on the command line.
246 * - ``update.sync-submodules``
247 - Boolean. If ``true`` (the default), :ref:`west-update` will synchronize
249 * - ``zephyr.base``
250 - String, default value to set for the :envvar:`ZEPHYR_BASE` environment
254 setting is ignored unless ``zephyr.base-prefer`` is ``"configfile"``.
255 * - ``zephyr.base-prefer``
256 - String, one the values ``"env"`` and ``"configfile"``. If set to