Skip to content

Commit 189e875

Browse files
tejlmandaescolar
authored andcommitted
doc: change plank.yaml to plank_<qualifiers>.yaml
The board file used by twister is the normalized board target and not just the board name. Indicate this by changing plank.yaml to plank_<qualifiers>.yaml in the board porting guide. Signed-off-by: Torsten Rasmussen <[email protected]>
1 parent 95cc5f5 commit 189e875

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

doc/hardware/porting/board_porting.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -265,11 +265,9 @@ Your board directory should look like this:
265265
│   └── index.rst
266266
├── Kconfig.plank
267267
├── Kconfig.defconfig
268-
├── plank_defconfig
269268
├── plank_<qualifiers>_defconfig
270-
├── plank.dts
271269
├── plank_<qualifiers>.dts
272-
└── plank.yaml
270+
└── plank_<qualifiers>.yaml
273271
274272
Replace ``plank`` with your board's name, of course.
275273

@@ -280,7 +278,7 @@ The mandatory files are:
280278
CPU clusters for multi-core SoCs are not described in this file as they are
281279
inherited from the SoC's YAML description.
282280

283-
#. :file:`plank.dts` or :file:`plank_<qualifiers>.dts`: a hardware description
281+
#. :file:`plank_<qualifiers>.dts`: a hardware description
284282
in :ref:`devicetree <dt-guide>` format. This declares your SoC, connectors,
285283
and any other hardware components such as LEDs, buttons, sensors, or
286284
communication peripherals (USB, BLE controller, etc).
@@ -304,8 +302,8 @@ The optional files are:
304302
- :file:`doc/index.rst`, :file:`doc/plank.png`: documentation for and a picture
305303
of your board. You only need this if you're :ref:`contributing-your-board` to
306304
Zephyr.
307-
- :file:`plank.yaml`: a YAML file with miscellaneous metadata used by the
308-
:ref:`twister_script`.
305+
- :file:`plank_<qualifiers>.yaml`: a YAML file with miscellaneous metadata used
306+
by the :ref:`twister_script`.
309307

310308
Board qualifiers of the form ``<soc>/<cpucluster>/<variant>`` are normalized so
311309
that ``/`` is replaced with ``_`` when used for filenames, for example:

0 commit comments

Comments
 (0)