Skip to content

Commit f1bafda

Browse files
danieldegrassecarlescufi
authored andcommitted
docs: getting_started: add note about west boards command
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 <[email protected]>
1 parent e1bcc0a commit f1bafda

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

doc/develop/getting_started/index.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,9 @@ Build the Blinky Sample
648648
does not meet Blinky's :ref:`blinky-sample-requirements`, then
649649
:ref:`hello_world` is a good alternative.
650650

651+
If you are unsure what name west uses for your board, ``west boards``
652+
can be used to obtain a list of all boards Zephyr supports.
653+
651654
Build the :ref:`blinky-sample` with :ref:`west build <west-building>`, changing
652655
``<your-board-name>`` appropriately for your board:
653656

@@ -658,24 +661,26 @@ Build the :ref:`blinky-sample` with :ref:`west build <west-building>`, changing
658661
.. code-block:: bash
659662
660663
cd ~/zephyrproject/zephyr
661-
west build -p auto -b <your-board-name> samples/basic/blinky
664+
west build -p always -b <your-board-name> samples/basic/blinky
662665
663666
.. group-tab:: macOS
664667

665668
.. code-block:: bash
666669
667670
cd ~/zephyrproject/zephyr
668-
west build -p auto -b <your-board-name> samples/basic/blinky
671+
west build -p always -b <your-board-name> samples/basic/blinky
669672
670673
.. group-tab:: Windows
671674

672675
.. code-block:: bat
673676
674677
cd %HOMEPATH%\zephyrproject\zephyr
675-
west build -p auto -b <your-board-name> samples\basic\blinky
678+
west build -p always -b <your-board-name> samples\basic\blinky
676679
677-
The ``-p auto`` option automatically cleans byproducts from a previous build
678-
if necessary, which is useful if you try building another sample.
680+
The ``-p always`` option forces a pristine build, and is recommended for new
681+
users. Users may also use the ``-p auto`` option, which will use
682+
heuristics to determine if a pristine build is required, such as when building
683+
another sample.
679684

680685
.. rst-class:: numbered-step
681686

0 commit comments

Comments
 (0)