| /Zephyr-latest/doc/develop/west/ |
| D | basics.rst | 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
[all …]
|
| D | release-notes.rst | 3 West Release Notes
11 - New ``west grep`` command for running a "grep tool" in your west workspace's
20 west grep foo
23 with ``west grep``:
28 - ``west grep --untracked foo``
30 - ``west grep --tool ripgrep foo``
32 - ``west grep --tool grep foo``
40 - ``west config grep.tool ripgrep``
42 - ``west config grep.tool grep``
44 For more details, run ``west help grep``.
[all …]
|
| D | index.rst | 3 West (Zephyr's meta-tool)
7 ``west``\ [#west-name]_. West is developed in its own `repository`_.
9 West's built-in commands provide a multiple repository management system with
10 features inspired by Google's Repo tool and Git submodules. West is also
11 "pluggable": you can write your own west extension commands which add
12 additional features to west. Zephyr uses this to provide conveniences for
15 Like ``git`` and ``docker``, the top-level ``west`` command takes some common
19 west [common-opts] <command> [opts] <args>
21 Since west v0.8, you can also run west like this::
23 python3 -m west [common-opts] <command> [opts] <args>
[all …]
|
| D | install.rst | 3 Installing west
6 West is written in Python 3 and distributed through `PyPI`_.
7 Use :file:`pip3` to install or upgrade west:
11 pip3 install --user -U west
15 pip3 install -U west
21 Afterwards, you can run ``pip3 show -f west`` for information on where the west
24 Once west is installed, you can use it to :ref:`clone the Zephyr repositories
32 West's code is distributed via PyPI in a Python package named ``west``.
34 ``west`` (or ``west.exe`` on Windows).
36 When west is installed, the launcher is placed by :file:`pip3` somewhere in
[all …]
|
| D | without-west.rst | 1 .. _no-west:
3 Using Zephyr without west
6 This page provides information on using Zephyr without west. This is
20 If you have previously installed west and want to stop using it,
25 pip3 uninstall west
35 :term:`west manifest` file inside that repository.
42 # clone additional repositories listed in zephyr/west.yml,
53 without west installed if you specify any modules manually.
62 When building with west installed, the Zephyr build system will use it to set
65 If you don't have west installed and your application does not need any of
[all …]
|
| D | built-in.rst | 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
[all …]
|
| D | troubleshooting.rst | 3 Troubleshooting West
6 This page covers common issues with west and how to solve them.
8 ``west update`` fetching failures
11 One good way to troubleshoot fetching issues is to run ``west update`` in
16 west -v update
18 The output includes Git commands run by west and their outputs. Look for
24 west.manifest: your_project: checking if cloned
25 [...other west.manifest logs...]
27 …west.manifest: running 'git fetch ... https://github.com/your-username/your_project ...' in /some/…
41 for a password when you run it directly, you will be able to run ``west
[all …]
|
| D | moving-to-west.rst | 1 .. _moving-to-west:
3 Moving to West
6 To convert a "pre-west" Zephyr setup on your computer to west, follow these
8 instead. See :ref:`west-troubleshooting` for advice on common issues.
10 #. Install west.
14 pip3 install --user -U west
18 pip3 install -U west
20 For details, see :ref:`west-install`.
40 #. Create a :ref:`west workspace <west-workspace>` using the zephyr
43 west init -l zephyr
[all …]
|
| D | extensions.rst | 6 West is "pluggable": you can add your own commands to west without editing its
7 source code. These are called **west extension commands**, or just "extensions"
8 for short. Extensions show up in the ``west --help`` output in a special
10 information on west extension commands, and has a tutorial for writing your
13 Some commands you can run when using west with Zephyr, like the ones used to
14 :ref:`build, flash, and debug <west-build-flash-debug>` and the
15 :ref:`ones described here <west-zephyr-ext-cmds>` , are extensions. That's why
16 help for them shows up like this in ``west --help``:
30 See :file:`zephyr/scripts/west-commands.yml` and the
37 :ref:`configuration <west-config>` option to ``false``. To set this
[all …]
|
| D | build-flash-debug.rst | 6 Zephyr provides several :ref:`west extension commands <west-extensions>` for
23 Building: ``west build``
26 .. tip:: Run ``west build -h`` for a quick overview.
29 use :ref:`west config <west-config-cmd>` to configure its behavior.
35 run ``west build`` from a Zephyr build directory.
37 - Otherwise, if you run ``west build`` from a Zephyr application's source
44 The easiest way to use ``west build`` is to go to an application's root
48 west build -b <BOARD>
56 You can use the :ref:`west boards <west-boards>` command to list all
60 be compiled there after ``west build`` runs CMake to create a build system in
[all …]
|
| D | config.rst | 6 This page documents west's configuration file system, the ``west config``
8 documentation on the ``west.configuration`` module, see
9 :ref:`west-apis-configuration`.
11 West Configuration Files
14 West's configuration file syntax is INI-like; here is an example file:
29 1. **System**: Settings in this file affect west's behavior for every user
34 - Windows: :file:`%PROGRAMDATA%\\west\\config`
36 2. **Global** (per user): Settings in this file affect how west behaves when
42 then :file:`$XDG_CONFIG_HOME/west/config` is used.
47 3. **Local**: Settings in this file affect west's behavior for the
[all …]
|
| D | workspaces.rst | 6 This page describes the *west workspace* concept introduced in
7 :ref:`west-basics` in more detail.
14 West creates and controls a Git branch named ``manifest-rev`` in each
16 specified for the project at the time :ref:`west-update` was last run.
22 Although ``manifest-rev`` is a normal Git branch, west will recreate and/or
25 you manually add to this branch may be lost the next time you run ``west
32 West does not create a ``manifest-rev`` branch in the manifest repository,
33 since west does not manage the manifest repository's branches or revisions.
35 The ``refs/west/*`` Git refs
38 West also reserves all Git refs that begin with ``refs/west/`` (such as
[all …]
|
| D | alias.rst | 3 West aliases
6 West allows to add alias commands to the local, global or system configuration files.
18 To add a new alias simply call the ``west config`` command:
22 west config alias.mylist "list -f '{name} {revision}'"
24 To list aliases, use :samp:`west help {some_alias}`.
33 west config alias.update "update -o=--depth=1 -n"
43 Add ``west run`` and ``west menuconfig`` shortcuts to your global configuration to
44 call ``west build`` with the corresponding CMake targets:
48 west config --global alias.run "build --pristine=never --target run"
49 west config --global alias.menuconfig "build --pristine=never --target menuconfig"
[all …]
|
| D | sign.rst | 6 The ``west sign`` :ref:`extension <west-extensions>` command can be used to
8 external tool. In some configurations, ``west sign`` is also used to invoke
10 the image together. Run ``west sign -h`` for command line help.
16 but on :ref:`west config<west-config>`, similar to
17 :ref:`west-building-cmake-config`.
19 Signing involves a number of "wrapper" scripts stacked on top of each other: ``west
20 flash`` invokes ``west build`` which invokes ``cmake`` and ``ninja`` which invokes
21 ``west sign`` which invokes ``imgtool`` or `rimage`_. As long as the signing
27 difficult. Reproducing a lower ``west sign`` command to debug some build-time issue
34 To avoid these issues, ``rimage`` parameters can bet set in ``west config``.
[all …]
|
| D | west-apis.rst | 4 .. _west-apis-west:
6 West APIs
9 This page documents the Python APIs provided by :ref:`west <west>`, as well as
10 some additional APIs used by the :ref:`west extensions <west-extensions>` in
21 2. if you add a :ref: target here, add it to west-not-found.rst too.
25 west.commands
28 .. module:: west.commands
37 .. autoclass:: west.commands.WestCommand
71 A property which returns the :py:class:`west.manifest.Manifest`
87 :py:class:`west.configuration.Configuration` instance or aborts the
[all …]
|
| D | manifest.rst | 3 West Manifests
6 This page contains detailed information about west's multiple repository model,
7 manifest files, and the ``west manifest`` command. For API documentation on the
8 ``west.manifest`` module, see :ref:`west-apis-manifest`. For a more general
9 introduction and command overview, see :ref:`west-basics`.
21 West's view of the repositories in a :term:`west workspace`, and their
23 specific to upstream Zephyr's use of west):
25 .. figure:: west-mr-model.png
27 :alt: West multi-repo history
30 West multi-repo history
[all …]
|
| D | zephyr-cmds.rst | 6 This page documents miscellaneous :ref:`west-zephyr-extensions`.
10 Listing boards: ``west boards``
18 west boards
24 west boards -f "{arch}:{name}"
28 west boards -h
32 Shell completion scripts: ``west completion``
46 west help completion
50 Installing CMake packages: ``west zephyr-export``
74 Software bill of materials: ``west spdx``
88 west spdx --init -d BUILD_DIR
[all …]
|
| D | why.rst | 6 West was added to the Zephyr project to fulfill two fundamental requirements:
12 During the development of west, a set of :ref:`west-design-constraints` were
39 Some of west's features are similar to those provided by
43 Existing tools were considered during west's initial design and development.
82 See :ref:`west-basics` for information on how west workspaces manage multiple
90 West is:
93 command-line tools, i.e. use Zephyr without using west (although west itself
95 always be *convenient* to do so, however. (If all of west's features
103 - **Cross-platform**: West is written in Python 3, and works on all
106 - **Usable as a Library**: whenever possible, west features are
[all …]
|
| D | west-not-found.rst | 4 .. _west-apis-west:
12 West APIs
15 The west APIs are not documented since either west was missing or the zephyr
16 repository was not initialized using west during the documentation build.
|
| /Zephyr-latest/scripts/west_commands/completion/ |
| D | west-completion.fish | 1 # check if we are currently in a west workspace
4 # return 0 if in west workspace
7 west topdir &>/dev/null
36 # argv[n] are the arguments to count, if not specified will count all arguments after 'west <comman…
120 # we don't want the command completion when doing `west help <cmd>`
150 set projects (west "-z $zephyr_base" list --format="{name}")
152 set projects (west list --format="{name}")
158 # return the list of available west commands
160 set -l builtin_cmds "init" "create a west repository" \
161 "update" "update projects described in west manifest" \
[all …]
|
| /Zephyr-latest/cmake/modules/ |
| D | west.cmake | 7 # west is an optional dependency. We need to run west using the same
11 # When west runs cmake, it sets WEST_PYTHON to its interpreter. If
12 # it's defined, we assume west is installed. We do these checks here
38 "import west.version; print(west.version.__version__, end='')"
48 The Python version used by west is: ${WEST_PYTHON}${west_realpath_msg}\n\
52 …message(FATAL_ERROR "Unable to import west.version from '${PYTHON_EXECUTABLE}':\n${west_version_er…
54 ${PYTHON_EXECUTABLE} -m pip install west\
57 # WEST_PYTHON is undefined and we couldn't import west. That's
59 set(WEST WEST-NOTFOUND CACHE INTERNAL "West") variable
62 # We can import west from PYTHON_EXECUTABLE and have its version.
[all …]
|
| /Zephyr-latest/scripts/west_commands/ |
| D | completion.py | 8 from west.commands import WestCommand
11 COMPLETION_REL_PATH = 'completion/west-completion'
14 Output shell completion scripts for west.
21 source <(west completion bash)
23 west completion bash > ~/west-completion.bash
25 source $HOME/west-completion.bash
29 source <(west completion zsh)
31 west completion zsh > "${fpath[1]}/_west"
35 west completion fish | source
37 west completion fish > $HOME/.config/fish/completions/west.fish
[all …]
|
| /Zephyr-latest/doc/ |
| D | glossary.rst | 159 west
160 A multi-repo meta-tool developed for the Zephyr project. See :ref:`west`.
162 west installation
163 An obsolete term for a :term:`west workspace` used prior to west 0.7.
165 west manifest
166 A YAML file, usually named :file:`west.yml`, which describes projects, or
167 the Git repositories which make up a :term:`west workspace`, along with
168 additional metadata. See :ref:`west-basics` for general information
169 and :ref:`west-manifests` for details.
171 west manifest repository
[all …]
|
| /Zephyr-latest/doc/develop/getting_started/ |
| D | index.rst | 209 Next, clone Zephyr and its :ref:`modules <modules>` into a new :ref:`west
210 <west>` workspace named :file:`zephyrproject`. You'll also install Zephyr's
246 #. Install west:
250 pip install west
256 west init ~/zephyrproject
258 west update
266 west zephyr-export
268 #. The Zephyr west extension command, ``west packages`` can be used to install Python
273 west packages pip --install
298 #. Install west:
[all …]
|
| /Zephyr-latest/doc/develop/manifest/ |
| D | index.rst | 5 West Projects index
15 call :command:`west update`. Many of the projects or modules listed below are
22 west config manifest.project-filter -- -hal_FOO
23 west update
33 call :command:`west update`. You can add any of the projects or modules listed below
39 west config manifest.project-filter -- +nanopb
40 west update
52 file which includes them. See :ref:`west-manifest-import` for information on
54 Zephyr's :file:`west.yml`.
|
