zephyr/scripts/west_commands
Martí Bolívar 6e4c2b9be9 scripts: clean up west build/flash/debug help
Just changes to the west help output; no functional changes expected.

Make option descriptions lowercase to match the argparse module's
conventions. When multiple sentences are required, move them to parser
prolog/epilog or argument group description sections.

Clarify some points that have confused multiple people.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-06-29 08:47:04 -04:00
..
completion cmake: West extension command for Zephyr config package registration 2020-03-27 16:23:46 +01:00
runners runners: promote --erase to common option 2020-06-25 12:14:25 +02:00
tests scripts: add unit test for mdb runner 2020-06-11 10:02:11 -04:00
boards.py scripts: west-commands: Updates needed when removing ZEPHYR_BASE env 2020-03-27 16:23:46 +01:00
build_helpers.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
build.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
completion.py
debug.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
export.py scripts: fix west zephyr-export error handling 2020-04-16 07:46:18 -04:00
flash.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
README.txt
run_common.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00
sign.py scripts: west-commands: Updates needed when removing ZEPHYR_BASE env 2020-03-27 16:23:46 +01:00
zcmake.py west: zcmake.py: manage STATIC type of CMakeCache.txt file 2020-04-20 15:44:09 +02:00
zephyr_ext_common.py scripts: clean up west build/flash/debug help 2020-06-29 08:47:04 -04:00

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=$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\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!