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 <declan.snyder@nxp.com>
diff --git a/doc/hardware/porting/board_porting.rst b/doc/hardware/porting/board_porting.rst
index 591f7e7..48e31ec 100644
--- a/doc/hardware/porting/board_porting.rst
+++ b/doc/hardware/porting/board_porting.rst
@@ -129,6 +129,15 @@
started. See :ref:`custom_board_definition` for documentation on moving your
board directory to a separate repository once it's working.)
+.. note::
+
+ The board directory name does not need to match the name of the board.
+ Multiple boards can even defined be in one directory.
+ For example, for boards with multi-core SoC, a logical board might be created
+ for each core following the naming scheme `<board>_<soc-core>`, with definitions
+ for all of these different boards defined inside the same directory. This and
+ similar schemes are common for upstream vendor boards.
+
Your board directory should look like this:
.. code-block:: none
