| /Zephyr-Core-2.7.6/doc/guides/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 *projects* (Git
20 zephyrproject/ # west topdir
21 ├── .west/ # marks the location of the topdir
24 │ # The manifest repository, never modified by west after creation:
26 │ ├── west.yml # manifest file
29 │ # Projects managed by west:
42 Additional details are in :ref:`west-workspaces`.
50 using :ref:`west init <west-init-basics>`.
52 .west directory
[all …]
|
| D | release-notes.rst | 3 West Release Notes
11 - ``west status`` now only prints output for projects which have a nonempty
23 :ref:`west-manifests-projects` for examples.
25 - The changes made in west v0.10.1 to the ``west init --manifest-rev`` option
31 overrides the default location, :file:`<workspace topdir>/.west/config`.
33 - ``west update --fetch=smart`` (``smart`` is the default) now correctly skips
41 ``west init --manifest-rev`` option value, if given, must now be either a
45 and check out such revisions manually after running ``west init``.
47 :ref:`API <west-apis>` changes:
49 - ``west.manifest.Manifest.get_projects()`` avoids incorrect results in
[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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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
15 These APIs should be considered unstable until west version 1.0 (see `west
19 https://github.com/zephyrproject-rtos/west/issues/38
29 2. if you add a :ref: target here, add it to west-not-found.rst too.
33 west.commands
36 .. module:: west.commands
45 .. py:class:: west.commands.WestCommand
[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 | 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 | sign.rst | 6 The ``west sign`` :ref:`extension <west-extensions>` command can be used to
8 external tool. Run ``west sign -h`` for command line help.
16 step by setting some Kconfig options. If you do, ``west flash`` will use the
19 If you use this feature, you don't need to run ``west sign`` yourself; the
29 west build -b YOUR_BOARD -s bootloader/mcuboot/boot/zephyr -d build-mcuboot
30 west build -b YOUR_BOARD -s zephyr/samples/hello_world -d build-hello-signed -- \
34 west flash -d build-mcuboot
35 west flash -d build-hello-signed
49 - :kconfig:`CONFIG_MCUBOOT_SIGNATURE_KEY_FILE`: the key file to use with ``west
59 If your ``west flash`` :ref:`runner <west-runner>` uses an image format
[all …]
|
| D | west-not-found.rst | 4 .. _west-apis-west:
11 West APIs
14 The west APIs are not documented since either west was missing or the zephyr
15 repository was not initialized using west during the documentation build.
|
| /Zephyr-Core-2.7.6/cmake/ |
| D | west.cmake | 3 # west is an optional dependency. We need to run west using the same
7 # When west runs cmake, it sets WEST_PYTHON to its interpreter. If
8 # it's defined, we assume west is installed. We do these checks here
34 "import west.version; print(west.version.__version__, end='')"
44 The Python version used by west is: ${WEST_PYTHON}${west_realpath_msg}\n\
48 …message(FATAL_ERROR "Unable to import west.version from '${PYTHON_EXECUTABLE}':\n${west_version_er…
50 ${PYTHON_EXECUTABLE} -m pip install west\
53 # WEST_PYTHON is undefined and we couldn't import west. That's
55 set(WEST WEST-NOTFOUND CACHE INTERNAL "West") variable
58 # We can import west from PYTHON_EXECUTABLE and have its version.
[all …]
|
| D | mcuboot.cmake | 14 # Property magic which makes west flash choose the signed build
30 if(NOT WEST)
31 # This feature requires west.
32 …message(FATAL_ERROR "Can't sign images for MCUboot: west not found. To fix, install west and ensur…
38 # Relative paths are relative to 'west topdir'.
43 …message(FATAL_ERROR "west sign can't find file ${${file}} (Note: Relative paths are relative to th…
50 # Find imgtool. Even though west is installed, imgtool might not be.
67 …. To fix, install imgtool with pip3, or add the mcuboot repository to the west manifest and ensure…
71 # Basic 'west sign' command and output format independent arguments.
72 set(west_sign ${WEST} sign --quiet --tool imgtool
[all …]
|
| /Zephyr-Core-2.7.6/doc/ |
| D | glossary.rst | 71 west
72 A multi-repo meta-tool developed for the Zephyr project. See :ref:`west`.
74 west installation
75 An obsolete term for a :term:`west workspace` used prior to west 0.7.
77 west manifest
78 A YAML file, usually named :file:`west.yml`, which describes projects, or
79 the Git repositories which make up a :term:`west workspace`, along with
80 additional metadata. See :ref:`west-basics` for general information
81 and :ref:`west-manifests` for details.
83 west manifest repository
[all …]
|
| /Zephyr-Core-2.7.6/.github/workflows/ |
| D | footprint.yml | 23 - name: Update PATH for west
33 - name: west setup
35 west init -l . || true
36 west config --global update.narrow true
37 west update 2>&1 1> west.update.log || west update 2>&1 1> west.update.log
49 west build -b frdm_k64f tests/benchmarks/footprints -t ram_report
51 west build -b frdm_k64f tests/benchmarks/footprints -t rom_report
55 west update
56 west build -p always -b frdm_k64f tests/benchmarks/footprints -t ram_report
57 west build -b frdm_k64f tests/benchmarks/footprints -t rom_report
|
| D | bluetooth-tests.yaml | 6 - "west.yml"
32 - name: Update PATH for west
39 - name: west setup
41 west init -l . || true
42 west config --global update.narrow true
43 west update 2>&1 1> west.update.log || west update 2>&1 1> west.update2.log
|
| D | footprint-tracking.yml | 34 - name: Update PATH for west
47 - name: west setup
49 west init -l . || true
50 west config --global update.narrow true
51 west update 2>&1 1> west.update.log || west update 2>&1 1> west.update2.log
|
| /Zephyr-Core-2.7.6/doc/getting_started/ |
| D | index.rst | 183 Next, clone Zephyr and its :ref:`modules <modules>` into a new :ref:`west
184 <west>` workspace named :file:`zephyrproject`. You'll also install Zephyr's
187 Python is used by the ``west`` meta-tool as well as by many scripts invoked by
203 #. Install west, and make sure :file:`~/.local/bin` is on your
208 pip3 install --user -U west
216 west init ~/zephyrproject
218 west update
226 west zephyr-export
258 #. Install west:
262 pip install west
[all …]
|
| /Zephyr-Core-2.7.6/scripts/west_commands/ |
| D | debug.py | 7 '''west "debug", "debugserver", and "attach" commands.'''
11 from west.commands import WestCommand
21 # Keep this in sync with the string in west-commands.yml.
25 debugging session. Use "west attach" instead to attach
42 # Keep this in sync with the string in west-commands.yml.
66 # Keep this in sync with the string in west-commands.yml.
68 "Like \"west debug\", but doesn't reflash the program.",
|
