zephyr/doc/guides/west/zephyr-cmds.rst
Carles Cufi d6f033e690 west: Add a boards command
Add a new "boards" command that is able to list all the boards in the
upstream tree. There is currently no support for out-of-tree boards.

The command executes cmake to use the built-in CMake script,
boards.cmake, to list the boards, and then stores the information
retrieved and allows the user to present it in a user-definable format.

Fixes https://github.com/zephyrproject-rtos/west/issues/53

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-05-03 21:55:13 +02:00

40 lines
1021 B
ReStructuredText

.. _west-zephyr-ext-cmds:
Additional Zephyr extension commands
####################################
Aside from the :ref:`build, flash, and debug commands <west-build-flash-debug>`,
the zephyr tree extends the west command set with additional zephyr-specific
commands.
.. 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.
.. only:: html
.. contents::
:local:
.. _west-boards:
Listing boards: ``west boards``
*******************************
The ``boards`` command can be used to list the boards that are supported by
Zephyr without having to resort to additional sources of information.
It can be run by typing::
west boards
This command lists all supported boards in a default format. If you prefer to
specify the display format yourself you can use the ``--format`` (or ``-f``)
flag::
west boards -f "{arch}:{name}"
Additional help about the formatting options can be found by running::
west boards -h