michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: west: add pointer to board porting guide for flash/debug

Browse source 
The board porting guide now has useful information on supporting
flash/debug commands. Link to it from the top of the page describing
these commands to hopefully make it easier to find.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2020-03-17 16:38:22 -07:00 • committed by Carles Cufí
commit 0206feb6bc
1 changed files with 2 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/guides/west/build-flash-debug.rst
View file

@ -7,12 +7,8 @@ Zephyr provides several :ref:`west extension commands <west-extensions>` for
building, flashing, and interacting with Zephyr programs running on a board:
``build``, ``flash``, ``debug``, ``debugserver`` and ``attach``.
These use information stored in the CMake cache [#cmakecache]_ to
flash or attach a debugger to a board supported by Zephyr. The exception is
starting a clean build (i.e. with no previous artifacts) which will in fact
run CMake thus creating the corresponding cache.
The CMake build system commands with the same names (i.e. all but ``build``)
directly delegate to West.
For information on adding board support for the flashing and debugging
commands, see :ref:`flash-and-debug-support` in the board porting guide.
.. Add a per-page contents at the top of the page. This page is nested
deeply enough that it doesn't have any subheadings in the main nav.
@ -612,12 +608,6 @@ commands do it).
.. rubric:: Footnotes
.. [#cmakecache]
The CMake cache is a file containing saved variables and values
which is created by CMake when it is first run to generate a build
system. See the `cmake(1)`_ manual for more details.
.. _cmake(1):
https://cmake.org/cmake/help/latest/manual/cmake.1.html