dasharo/zephyr
0
0
Fork 0
mirror of https://github.com/Dasharo/zephyr.git synced 2026-03-06 14:57:20 -08:00
Code Issues Packages Projects Releases Wiki Activity

docs: getting_started: add note about west boards command

Browse Source 
Add note about west boards command to getting started documentation,
to make it easier for users to determine the name of their board when used
with west. Also change "-p auto" to "-p always" in the build step, since
this is more deterministic

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
This commit is contained in:
Daniel DeGrasse
2022-06-27 12:27:07 -05:00
committed by Carles Cufí
parent e1bcc0a0cc
commit f1bafda5e5
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/develop/getting_started/index.rst
View File

@@ -648,6 +648,9 @@ Build the Blinky Sample
does not meet Blinky's :ref:`blinky-sample-requirements`, then
:ref:`hello_world` is a good alternative.
If you are unsure what name west uses for your board, ``west boards``
can be used to obtain a list of all boards Zephyr supports.
Build the :ref:`blinky-sample` with :ref:`west build <west-building>`, changing
``<your-board-name>`` appropriately for your board:
@@ -658,24 +661,26 @@ Build the :ref:`blinky-sample` with :ref:`west build <west-building>`, changing
.. code-block:: bash
cd ~/zephyrproject/zephyr
west build -p auto -b <your-board-name> samples/basic/blinky
west build -p always -b <your-board-name> samples/basic/blinky
.. group-tab:: macOS
.. code-block:: bash
cd ~/zephyrproject/zephyr
west build -p auto -b <your-board-name> samples/basic/blinky
west build -p always -b <your-board-name> samples/basic/blinky
.. group-tab:: Windows
.. code-block:: bat
cd %HOMEPATH%\zephyrproject\zephyr
west build -p auto -b <your-board-name> samples\basic\blinky
west build -p always -b <your-board-name> samples\basic\blinky
The ``-p auto`` option automatically cleans byproducts from a previous build
if necessary, which is useful if you try building another sample.
The ``-p always`` option forces a pristine build, and is recommended for new
users. Users may also use the ``-p auto`` option, which will use
heuristics to determine if a pristine build is required, such as when building
another sample.
.. rst-class:: numbered-step