Skip to content

Commit 62abf16

Browse files
decsnyfabiobaltieri
authored andcommitted
doc: board porting: Add clarifications
Clarify: - Board directory name does not need to match board name - Give example of multi board directory Signed-off-by: Declan Snyder <[email protected]>
1 parent 5d8c79f commit 62abf16

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/hardware/porting/board_porting.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,15 @@ board directory in the zephyr repository, but it's the easiest way to get
129129
started. See :ref:`custom_board_definition` for documentation on moving your
130130
board directory to a separate repository once it's working.)
131131

132+
.. note::
133+
134+
The board directory name does not need to match the name of the board.
135+
Multiple boards can even defined be in one directory.
136+
For example, for boards with multi-core SoC, a logical board might be created
137+
for each core following the naming scheme `<board>_<soc-core>`, with definitions
138+
for all of these different boards defined inside the same directory. This and
139+
similar schemes are common for upstream vendor boards.
140+
132141
Your board directory should look like this:
133142

134143
.. code-block:: none

0 commit comments

Comments
 (0)