zephyr/scripts/west_commands
Martí Bolívar 4ac96079a7 west: flash/debug: try to make --context more prominent
I keep seeing people miss the --context option in the "west flash
--help" output.

This option is very important for understanding the runner-specific
options and state, and missing it means people get confused about what
west flash, debug, etc. can do and are doing.

Try to avoid this problem by adding a big fat banner about the
omission of runner-specific options in the main help output, and
provide more hints about how to use --context.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-11-17 16:38:36 -05:00
..
completion cmake: West extension command for Zephyr config package registration 2020-03-27 16:23:46 +01:00
runners ARC: west: mdb runner: record MDB's CLD process pid to file 2020-11-11 08:18:38 -05:00
tests ARC: west: mdb runner: record MDB's CLD process pid to file 2020-11-11 08:18:38 -05:00
boards.py scripts: west-commands: Updates needed when removing ZEPHYR_BASE env 2020-03-27 16:23:46 +01:00
build_helpers.py west build: fix --pristine on early build system failure 2020-10-14 07:22:32 -05:00
build.py scripts: west build: default build.pristine to auto 2020-09-05 11:06:39 +02:00
completion.py west: completion.py: Fix bad indentation and blank lines at end of file 2019-09-07 08:09:56 -04:00
debug.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
export.py cmake: Zephyr CMake package clean-up and minor fix 2020-08-19 12:52:33 -04:00
flash.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
mypy.ini scripts: runners: add type checking for west_commands 2020-09-03 16:49:09 -05:00
README.txt scripts: runners: add type checking for west_commands 2020-09-03 16:49:09 -05:00
run_common.py west: flash/debug: try to make --context more prominent 2020-11-17 16:38:36 -05:00
run_tests.py scripts: runners: add type checking for west_commands 2020-09-03 16:49:09 -05:00
sign.py scripts/west_commands: Don't demand non-empty output formats 2020-10-23 22:22:52 -04:00
zcmake.py cmake: west: invoke west using same python as rest of build system 2020-07-08 23:23:04 -04:00
zephyr_ext_common.py scripts: west_commands: remove unused helper 2020-08-19 09:51:13 -04:00

This directory contains implementations for west commands which are
tightly coupled to the zephyr tree. This includes 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 Zephyr-specific features.

When extending this code, please keep the unit tests (in tests/) up to
date. The mypy static type checker is also run on the runners package.

To run these tests locally on Windows, run:

   py -3 run_tests.py

On macOS and Linux:

   ./run_tests.py

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!