Searched +full:west +full:- +full:commands (Results 1 – 25 of 248) sorted by relevance
12345678910
| /Zephyr-Core-3.5.0/doc/develop/west/ |
| D | extensions.rst | 1 .. _west-extensions:
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``:
18 .. code-block:: none
[all …]
|
| D | release-notes.rst | 1 .. _west-release-notes:
3 West Release Notes
11 - ``west compare``: new command that compares the state of the
14 - Support for a new ``manifest.project-filter`` configuration option.
15 See :ref:`west-config-index` for details. The ``west manifest --freeze``
16 and ``west manifest --resolve`` commands currently cannot be used when
19 - Project names which contain comma (``,``) or whitespace now generate
20 warnings. These warnings are errors if the new ``manifest.project-filter``
22 future major version of west.
26 - ``west forall`` now takese a ``--group`` argument that can be used
[all …]
|
| D | built-in.rst | 1 .. _west-built-in-cmds:
3 Built-in commands
6 This page describes west's built-in commands, some of which were introduced in
7 :ref:`west-basics`, in more detail.
9 Some commands are related to Git commands with the same name, but operate
10 on the entire workspace. For example, ``west diff`` shows local changes in
13 Some commands take projects as arguments. These arguments can be project
15 on the local file system. Omitting project arguments to commands which
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``).
[all …]
|
| D | index.rst | 3 West (Zephyr's meta-tool)
6 The Zephyr project includes a swiss-army knife command line tool named
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
16 options, a sub-command to run, and then options and arguments for that
17 sub-command::
[all …]
|
| D | basics.rst | 1 .. _west-basics:
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
18 .. code-block:: none
20 zephyrproject/ # west topdir
21 ├── .west/ # marks the location of the topdir
22 │ └── config # per-workspace local configuration file
24 │ # The manifest repository, never modified by west after creation:
26 │ ├── west.yml # manifest file
29 │ # Projects managed by west:
[all …]
|
| D | config.rst | 1 .. _west-config:
6 This page documents west's configuration file system, the ``west config``
7 command, and configuration options used by built-in commands. For API
8 documentation on the ``west.configuration`` module, see
9 :ref:`west-apis-configuration`.
11 West Configuration Files
12 ------------------------
14 West's configuration file syntax is INI-like; here is an example file:
16 .. code-block:: ini
29 1. **System**: Settings in this file affect west's behavior for every user
[all …]
|
| D | west-apis.rst | 3 .. _west-apis:
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.
23 .. _west-apis-commands:
25 west.commands
28 .. module:: west.commands
30 All built-in and extension commands are implemented as subclasses of the
[all …]
|
| D | troubleshooting.rst | 1 .. _west-troubleshooting:
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
14 .. code-block:: shell
16 west -v update
18 The output includes Git commands run by west and their outputs. Look for
21 .. code-block:: none
24 west.manifest: your_project: checking if cloned
[all …]
|
| D | west-not-found.rst | 3 .. _west-apis:
4 .. _west-apis-west:
5 .. _west-apis-commands:
6 .. _west-apis-westcommand:
7 .. _west-apis-configuration:
8 .. _west-apis-log:
9 .. _west-apis-manifest:
10 .. _west-apis-util:
12 West APIs
15 The west APIs are not documented since either west was missing or the zephyr
[all …]
|
| D | build-flash-debug.rst | 1 .. _west-build-flash-debug:
6 Zephyr provides several :ref:`west extension commands <west-extensions>` for
11 commands, see :ref:`flash-and-debug-support` in the board porting guide.
13 .. Add a per-page contents at the top of the page. This page is nested
21 .. _west-building:
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.
33 - If there is a Zephyr build directory named :file:`build` in your current
34 working directory, it is incrementally re-compiled. The same is true if you
[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
11 - cloning the additional source code repositories used by Zephyr in
13 - specifying the locations of these repositories to the Zephyr build
15 - flashing and debugging without understanding detailed usage of the
20 If you have previously installed west and want to stop using it,
23 .. code-block:: console
25 pip3 uninstall west
31 ------------------
[all …]
|
| D | workspaces.rst | 1 .. _west-workspaces:
6 This page describes the *west workspace* concept introduced in
7 :ref:`west-basics` in more detail.
9 .. _west-manifest-rev:
11 The ``manifest-rev`` branch
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.
17 Other workspace management commands may use ``manifest-rev`` as a reference
19 purposes, the ``manifest-rev`` branch allows the manifest file to use SHAs
22 Although ``manifest-rev`` is a normal Git branch, west will recreate and/or
[all …]
|
| D | sign.rst | 1 .. _west-sign:
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
9 an external, post-processing tool that "stitches" the final components of
10 the image together. Run ``west sign -h`` for command line help.
18 step by setting some Kconfig options. If you do, ``west flash`` will use the
21 If you use this feature, you don't need to run ``west sign`` yourself; the
25 :ref:`hello_world` application for chain-loading by MCUboot. Run these commands
29 .. code-block:: console
31 west build -b YOUR_BOARD bootloader/mcuboot/boot/zephyr -d build-mcuboot
[all …]
|
| /Zephyr-Core-3.5.0/scripts/west_commands/ |
| D | debug.py | 5 # SPDX-License-Identifier: Apache-2.0
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
28 self.runner_key = 'debug-runner' # in runners.yaml
42 # Keep this in sync with the string in west-commands.yml.
52 self.runner_key = 'debug-runner' # in runners.yaml
66 # Keep this in sync with the string in west-commands.yml.
68 "Like \"west debug\", but doesn't reflash the program.",
[all …]
|
| D | README.txt | 1 This directory contains implementations for west commands which are
3 and debug commands.
6 extensions in upstream west. For example, any commands which operate
7 on the multi-repo need to be in upstream west, not here. Try to limit
8 what goes in here to Zephyr-specific features.
15 py -3 run_tests.py
|
| D | completion.py | 3 # SPDX-License-Identifier: Apache-2.0
8 from west import log
9 from west.commands import WestCommand
12 COMPLETION_REL_PATH = 'completion/west-completion'
15 Output shell completion scripts for west.
21 # one-time
22 source <(west completion bash)
24 west completion bash > ~/west-completion.bash
26 source $HOME/west-completion.bash
29 # one-time
[all …]
|
| D | zephyr_ext_common.py | 3 # SPDX-License-Identifier: Apache-2.0
5 '''Helpers shared by multiple west extension command modules.
8 commands are in run_common -- that's for common code used by
9 commands which specifically execute runners.'''
14 from west import log
15 from west.commands import WestCommand
27 '''WestCommand subclass for commands with a --force option.'''
31 '''Add a -f / --force option to the parser.'''
32 parser.add_argument('-f', '--force', action='store_true',
47 log.die('refusing to proceed without --force due to above error')
|
| D | flash.py | 5 # SPDX-License-Identifier: Apache-2.0
7 '''west "flash" command'''
9 from west.commands import WestCommand
20 # Keep this in sync with the string in west-commands.yml.
24 self.runner_key = 'flash-runner' # in runners.yaml
|
| D | twister_cmd.py | 3 # SPDX-License-Identifier: Apache-2.0
9 from west import log
10 from west.commands import WestCommand
35 # Keep this in sync with the string in west-commands.yml.
36 "west twister wrapper",
|
| /Zephyr-Core-3.5.0/doc/develop/manifest/ |
| D | index.rst | 5 West Projects index
8 See :ref:`external-contributions` for more information about
15 call `west update`. Many of the projects or modules listed below are
20 following commands::
22 west config manifest.project-filter -- -hal_FOO
23 west update
25 .. manifest-projects-table::
33 call `west update`. You can add any of the the projects or modules listed below
37 To enable any of the modules below, use the following commands::
39 west config manifest.project-filter -- +nanopb
[all …]
|
| /Zephyr-Core-3.5.0/scripts/ |
| D | west-commands.yml | 2 west-commands:
3 - file: scripts/west_commands/completion.py
4 commands:
5 - name: completion
8 - file: scripts/west_commands/boards.py
9 commands:
10 - name: boards
13 - file: scripts/west_commands/build.py
14 commands:
15 - name: build
[all …]
|
| /Zephyr-Core-3.5.0/samples/subsys/ipc/openamp/ |
| D | README.rst | 1 .. zephyr:code-sample:: openamp
3 :relevant-api: ipm_interface
18 .. zephyr-app-commands::
19 :zephyr-app: samples/subsys/ipc/openamp
22 :west-args: --sysbuild
27 .. zephyr-app-commands::
28 :zephyr-app: samples/subsys/ipc/openamp
31 :west-args: --sysbuild
36 .. zephyr-app-commands::
37 :zephyr-app: samples/subsys/ipc/openamp
[all …]
|
| /Zephyr-Core-3.5.0/doc/build/sysbuild/ |
| D | index.rst | 6 Sysbuild is a higher-level build system that can be used to combine multiple
7 other build systems together. It is a higher-level layer that combines one
27 Single-image build
31 Multi-image build
39 Multi-domain
50 :figclass: align-center
55 - You can run sysbuild either with :ref:`west build
56 <west-building>` or directly via ``cmake``.
58 - You can use sysbuild to generate application images from each build system,
61 - You can configure sysbuild or any of the build systems it manages using
[all …]
|
| /Zephyr-Core-3.5.0/.github/workflows/ |
| D | west_cmds.yml | 2 # SPDX-License-Identifier: Apache-2.0
4 name: Zephyr West Command Tests
9 - main
10 - v*-branch
12 - 'scripts/west-commands.yml'
13 - 'scripts/west_commands/**'
14 - '.github/workflows/west_cmds.yml'
17 - main
18 - v*-branch
20 - 'scripts/west-commands.yml'
[all …]
|
| /Zephyr-Core-3.5.0/doc/_extensions/zephyr/ |
| D | application.py | 3 # SPDX-License-Identifier: Apache-2.0
19 of the shell commands needed to manage (build, flash, etc.) an application.
21 For example, to generate commands to build samples/hello_world for
24 .. zephyr-app-commands::
25 :zephyr-app: samples/hello_world
32 which tool to use. Valid options are currently 'cmake', 'west' and 'all'.
33 The default is 'west'.
38 \:zephyr-app:
42 \:cd-into:
51 \:host-os:
[all …]
|
12345678910
