From f1bafda5e594cc13a4efa1fbc44057104f89f8b6 Mon Sep 17 00:00:00 2001 From: Daniel DeGrasse Date: Mon, 27 Jun 2022 12:27:07 -0500 Subject: [PATCH] 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 --- doc/develop/getting_started/index.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/develop/getting_started/index.rst b/doc/develop/getting_started/index.rst index acf0530c59..b97f5c5ee8 100644 --- a/doc/develop/getting_started/index.rst +++ b/doc/develop/getting_started/index.rst @@ -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 `, changing ```` appropriately for your board: @@ -658,24 +661,26 @@ Build the :ref:`blinky-sample` with :ref:`west build `, changing .. code-block:: bash cd ~/zephyrproject/zephyr - west build -p auto -b samples/basic/blinky + west build -p always -b samples/basic/blinky .. group-tab:: macOS .. code-block:: bash cd ~/zephyrproject/zephyr - west build -p auto -b samples/basic/blinky + west build -p always -b samples/basic/blinky .. group-tab:: Windows .. code-block:: bat cd %HOMEPATH%\zephyrproject\zephyr - west build -p auto -b samples\basic\blinky + west build -p always -b 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