zephyr/scripts/west_commands
Marti Bolivar 83a5fd8d4c scripts: make west build -h fit on a screen
The west build --help output no longer fits in a single page.  Move
details and examples into the documentation, so the -h output doesn't
require scrolling around.

Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-05-06 16:30:05 -04:00
..
runners boards: rv32m1_vega: Use different openocd config file for each core 2019-05-06 14:52:17 -05:00
tests scripts: Remove unused imports in all Python scripts 2019-03-28 11:06:20 -05:00
README.txt west_commands: add information on running tests 2019-01-29 10:15:01 +01:00
boards.py scripts: fix and tweak west boards 2019-05-06 16:30:05 -04:00
build.py scripts: make west build -h fit on a screen 2019-05-06 16:30:05 -04:00
build_helpers.py scripts: make west build -h fit on a screen 2019-05-06 16:30:05 -04:00
debug.py scripts: west commands: add text for "west --help" 2019-01-29 10:15:01 +01:00
flash.py scripts: west commands: add text for "west --help" 2019-01-29 10:15:01 +01:00
run_common.py scripts: west_commands: refactor run_common.py 2019-02-07 08:44:19 -05:00
sign.py west: sign.py: usability fixes 2019-02-15 21:07:10 +01:00
zcmake.py scripts: add --dry-run flags to west build 2019-05-06 16:30:05 -04:00
zephyr_ext_common.py west: Implement CMake helpers in scripts/west_commands 2019-05-03 21:55:13 +02:00

README.txt

This directory contains implementations for west commands which are
tightly coupled to the zephyr tree. Currently, those are the build,
flash, and debug commands.

Before adding more here, consider whether you might want to put new
extensions in upstream west. For example, any commands which operate
on the multi-repo need to be in upstream west, not here. Try to limit
what goes in here to just those files that change along with Zephyr
itself.

When extending this code, please keep the unit tests (in tests/) up to
date. You can run the tests with this command from this directory:

$ PYTHONPATH=$(west list --format="{abspath}" west)/src:$PWD py.test

Windows users will need to find the path to .west/west/src in their
Zephyr installation, then run something like this:

> cmd /C "set PYTHONPATH=path\to\.west\west\src:path\to\zephyr\scripts\west_commands && py.test"

Note that these tests are run as part of Zephyr's CI when submitting
an upstream pull request, and pull requests which break the tests
cannot be merged.

Thanks!