Incorrect configuration override option for west flash #31630
Labels
area: West
West utility
bug
The issue is a bug, or the PR is fixing a bug
priority: low
Low impact/importance bug
Describe the bug
The documentation for West on "Building, Flashing and Debugging" has as section entitled "Configuration Overrides". [https://docs.zephyrproject.org/latest/guides/west/build-flash-debug.html#configuration-overrides]
)
It suggests that to specify an alternative HEX file one should execute the flash command with the --kernel-hex option:
west flash --kernel-hex path/to/some/other.hex
The help text for west flash indicates that this option has been renamed to --hex-file:
I used the following command and it successfully flashed my custom zephyr HEX file:
west flash --hex-file ~/Downloads/zephyr.hex
To Reproduce
Steps to reproduce the behavior:
Expected behavior
West should successfully flash the device using the custom zephyr.hex file.
Impact
The documentation may lead someone astray with the wrong option. However, the correct option is documented in the tool itself.
Logs and console output
Output of west flash -h:
Environment (please complete the following information):
Additional context
Add any other context about the problem here.
The source for the documentation is here: https://github.com/zephyrproject-rtos/zephyr/blob/master/doc/guides/west/build-flash-debug.rst
The text was updated successfully, but these errors were encountered: