Skip to content

Commit ae2836e

Browse files
mbolivar-nordiccarlescufi
authored andcommitted
doc: west: make it clearer how to override the default runner
Though BOARD_FLASH_RUNNER and BOARD_DEBUG_RUNNER are documented in the debug host tools page, these variables are important enough to deserve mention in the section dedicated to choosing a runner. Make it so. Signed-off-by: Martí Bolívar <[email protected]>
1 parent ca220e4 commit ae2836e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/guides/west/build-flash-debug.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,19 @@ the default with::
381381

382382
west flash --runner jlink
383383

384+
You can override the default flash runner at build time by using the
385+
``BOARD_FLASH_RUNNER`` CMake variable, and the debug runner with
386+
``BOARD_DEBUG_RUNNER``.
387+
388+
For example::
389+
390+
# Set the default runner to "jlink", overriding the board's
391+
# usual default.
392+
west build [...] -- -DBOARD_FLASH_RUNNER=jlink
393+
394+
See :ref:`west-building-cmake-args` and :ref:`west-building-cmake-config` for
395+
more information on setting CMake arguments.
396+
384397
See :ref:`west-runner` below for more information on the ``runner``
385398
library used by West. The list of runners which support flashing can
386399
be obtained with ``west flash -H``; if run from a build directory or

0 commit comments

Comments
 (0)