OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/scripts/west-commands.yml

39 lines
1.2 KiB
YAML
Raw Normal View History

scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
# Keep the help strings in sync with the values in the .py files!
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
west-commands:
west: Add completion command Add a completion command that dumps the contents of a shell completion file present in the zephyr repository. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-09 00:05:38 +08:00
- file: scripts/west_commands/completion.py
commands:
- name: completion
class: Completion
help: display shell completion scripts
west: Add a boards command Add a new "boards" command that is able to list all the boards in the upstream tree. There is currently no support for out-of-tree boards. The command executes cmake to use the built-in CMake script, boards.cmake, to list the boards, and then stores the information retrieved and allows the user to present it in a user-definable format. Fixes https://github.com/zephyrproject-rtos/west/issues/53 Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-04-24 04:34:40 +08:00
- file: scripts/west_commands/boards.py
commands:
- name: boards
class: Boards
help: display information about supported boards
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
- file: scripts/west_commands/build.py
commands:
- name: build
class: Build
scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
help: compile a Zephyr application
scripts: west_commands: add sign command This command is useful for signing binaries for loading by a bootloader. At present, only MCUboot's "imgtool" is supported, but it would be straightforward to add support for additional tools. Using this command instead of "plain" imgtool avoids looking up any numbers for the flash write block size, text section offset, or slot size to get a signed binary. All users need to specify is the location of the signing key. This greatly improves usability for those unfamiliar with MCUboot, or even experienced users who have to deal with multiple flash partition layouts, boards, etc. The command works by inspecting state in the Zephyr build system, some of which is also provided by the runner package. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-31 11:30:42 +08:00
- file: scripts/west_commands/sign.py
commands:
- name: sign
class: Sign
help: sign a Zephyr binary for bootloader chain-loading
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
- file: scripts/west_commands/flash.py
commands:
- name: flash
class: Flash
scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
help: flash and run a binary on a board
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
- file: scripts/west_commands/debug.py
commands:
- name: debug
class: Debug
scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
help: flash and interactively debug a Zephyr application
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
- name: debugserver
class: DebugServer
scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
help: connect to board and launch a debug server
scripts: add west build, flash, and debug commands West now supports a mechanism for extension commands. Use it to move the command implementations that are tightly coupled with boards and the zephyr build system back into the Zephyr repository. This patch doesn't include test cases. Those will be moved over in a subsequent patch. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-23 23:31:06 +08:00
- name: attach
class: Attach
scripts: west commands: add text for "west --help" Although each of these command implementations has good output for "west <command> --help", the "west --help" output is missing the one-line descriptions. Add them by modifying west-commands.yml to use a new 'help' key in each command name. These need to be kept in sync with the Python sources. For now just do that by copy/pasting. We could add fancy logic to load the help from west-commands.yml later if we want. Signed-off-by: Marti Bolivar <marti@foundries.io>
2019-01-29 01:45:02 +08:00
help: interactively debug a board