Skip to content

Commit 7a448ff

Browse files
golowanowlgirdwood
authored andcommitted
build-guide: Use Zephyr HWMv2 board names
Use Zephyr HWMv2 board names in `west build` command examples. Signed-off-by: Dmitrii Golovanov <[email protected]>
1 parent 49f3c6e commit 7a448ff

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

getting_started/build-guide/build-with-zephyr.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,17 +163,17 @@ Check out and build using west tool directly
163163

164164
.. code-block:: bash
165165
166-
west build --build-dir build-tgl --board intel_adsp_cavs25 ./sof/app
166+
west build --build-dir build-tgl --board intel_adsp/cavs25 ./sof/app
167167
168168
169-
Note that the SOF project defines platform names that have Zephyr board counterparts. In the above example, the *Tigerlake* platform matches the ``inteL_adsp_cavs25`` Zephyr board. This is why the output directory is named ``build-tgl``; however, you may use any name you wish.
169+
Note that the SOF project defines platform names that have Zephyr board counterparts. In the above example, the *Tigerlake* platform matches the ``intel_adsp/cavs25`` Zephyr board target (see `Zephyr HWMv2 board terminology <https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html#board-terminology>`_). This is why the output directory is named ``build-tgl``; however, you may use any name you wish.
170170

171171
.. note::
172172
To add verbosity to the build output use the -v -v flags. Example:
173-
``west -v -v build --build-dir build-tgl --board intel_adsp_cavs25 ./sof/app``
173+
``west -v -v build --build-dir build-tgl --board intel_adsp/cavs25 ./sof/app``
174174

175175
To perform a complete clean rebuild, use the --pristine flag. Example:
176-
``west -v -v build --build-dir build-tgl --pristine always --board intel_adsp_cavs25 ./sof/app``
176+
``west -v -v build --build-dir build-tgl --pristine always --board intel_adsp/cavs25 ./sof/app``
177177

178178
The ``.elf`` file produced by the ``west build`` is missing a
179179
manifest and signature. A a result, you must sign the file using the **rimage tool**

0 commit comments

Comments
 (0)