diff mbox series

[v2] bsp-guide: simplify example of structure of BSP layer

Message ID 6e1fcbc9-6a7a-9f72-6a91-74fc46cb44b3@crashcourse.ca
State New
Headers show
Series [v2] bsp-guide: simplify example of structure of BSP layer | expand

Commit Message

Robert P. J. Day May 22, 2026, 5:18 p.m. UTC
Rather than introduce a generic example of a BSP layer and follow that
with a link to meta-yocto-bsp, eliminate the middleman and just show a
clear hierarchical view of the meta-yocto-bsp layer where readers can
immediately see the point being made.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---
diff mbox series

Patch

diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index a3b57d29f..28fd9169d 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -1222,22 +1222,30 @@  Project Development Tasks Manual.
 BSP Machine Configuration Example
 ---------------------------------

-As mentioned earlier in this section, the existence of a machine
+As mentioned earlier in this section, the existence of at least one machine
 configuration file is what makes a layer a BSP layer as compared to a
 general or kernel layer.

-There are one or more machine configuration files in the
-``bsp_layer/conf/machine/`` directory of the layer::
-
-   bsp_layer/conf/machine/machine1\.conf
-   bsp_layer/conf/machine/machine2\.conf
-   bsp_layer/conf/machine/machine3\.conf
-   ... more ...
-
-For example, the machine configuration file for the `BeagleBone and
-BeagleBone Black development boards <https://beagleboard.org/bone>`__ is
-located in :yocto_git:`/meta-yocto/tree/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf
-</meta-yocto/tree/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf>`.
+As an actual example, consider the relevant content from the
+:yocto_git:`/meta-yocto/tree/meta-yocto-bsp/conf/
+</meta-yocto/tree/meta-yocto-bsp/conf/>` directory of the
+``meta-yocto-bsp`` BSP layer:
+
+.. code-block:: console
+
+   $ tree -F conf
+   conf/
+   О©╫О©╫О©╫ layer.conf
+   О©╫О©╫О©╫ machine/
+       О©╫О©╫О©╫ beaglebone-yocto.conf
+       О©╫О©╫О©╫ genericarm64.conf
+       О©╫О©╫О©╫ genericx86-64.conf
+       О©╫О©╫О©╫ genericx86.conf
+       О©╫О©╫О©╫ include/
+           О©╫О©╫О©╫ genericx86-common.inc
+
+showing four machine configuration files along with a lower-level
+tuning configuration file.

 The variables used to configure the machine define machine-specific properties; for
 example, machine-dependent packages, machine tunings, the type of kernel