From f4d83e76851173c3c34c110ea928bf73e71eb3de Mon Sep 17 00:00:00 2001 From: "Robert P. J. Day" Date: Thu, 12 Jun 2025 10:17:23 -0400 Subject: overview-manual: small number of pedantic cleanups In Sections 4.3.1 and 4.3.2 of the Overview Manual, a bit of tidying including: - provide full list of packaging options - add monospaced rendering where appropriate - fix broken "ref" - make capitalization consistent (From yocto-docs rev: 1cf769e3c8a8442cd05449dc97e91ad482d635f3) Signed-off-by: "Robert P. J. Day" Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/overview-manual/concepts.rst | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) (limited to 'documentation/overview-manual/concepts.rst') diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 85dea9fe05..c9405cdd33 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -98,7 +98,7 @@ files, and how to package the compiled output. The term "package" is sometimes used to refer to recipes. However, since the word "package" is used for the packaged output from the OpenEmbedded -build system (i.e. ``.ipk`` or ``.deb`` files), this document avoids +build system (i.e. ``.ipk``, ``.deb`` or ``.rpm`` files), this document avoids using the term "package" when referring to recipes. Classes @@ -256,7 +256,7 @@ development environment. .. note:: The - scripts/oe-setup-builddir + ``scripts/oe-setup-builddir`` script uses the ``$TEMPLATECONF`` variable to determine which sample configuration files to locate. @@ -352,7 +352,7 @@ layers the build system uses to further control the build. These layers provide Metadata for the software, machine, and policies. In general, there are three types of layer input. You can see them below -the "User Configuration" box in the `general workflow +the "User Configuration" box in the :ref:`general workflow figure `: - *Metadata (.bb + Patches):* Software layers containing @@ -420,14 +420,14 @@ build. Distro Layer ~~~~~~~~~~~~ -The distribution layer provides policy configurations for your +A distribution layer provides policy configurations for your distribution. Best practices dictate that you isolate these types of configurations into their own layer. Settings you provide in ``conf/distro/distro.conf`` override similar settings that BitBake finds in your ``conf/local.conf`` file in the :term:`Build Directory`. The following list provides some explanation and references for what you -typically find in the distribution layer: +typically find in a distribution layer: - *classes:* Class files (``.bbclass``) hold common functionality that can be shared among recipes in the distribution. When your recipes @@ -454,7 +454,7 @@ typically find in the distribution layer: BSP Layer ~~~~~~~~~ -The BSP Layer provides machine configurations that target specific +A BSP layer provides machine configurations that target specific hardware. Everything in this layer is specific to the machine for which you are building the image or the SDK. A common structure or form is defined for BSP layers. You can learn more about this structure in the @@ -465,7 +465,7 @@ defined for BSP layers. You can learn more about this structure in the In order for a BSP layer to be considered compliant with the Yocto Project, it must meet some structural requirements. -The BSP Layer's configuration directory contains configuration files for +A BSP layer's configuration directory contains configuration files for the machine (``conf/machine/machine.conf``) and, of course, the layer (``conf/layer.conf``). @@ -477,18 +477,18 @@ formfactors, graphics support systems, and so forth. .. note:: While the figure shows several - recipes-\* + ``recipes-*`` directories, not all these directories appear in all BSP layers. Software Layer ~~~~~~~~~~~~~~ -The software layer provides the Metadata for additional software +A software layer provides the Metadata for additional software packages used during the build. This layer does not include Metadata that is specific to the distribution or the machine, which are found in their respective layers. -This layer contains any recipes, append files, and patches, that your +This layer contains any recipes, append files, and patches that your project needs. Sources @@ -560,9 +560,8 @@ source tree used by the group). The canonical method through which to include a local project is to use the :ref:`ref-classes-externalsrc` class to include that local project. You use -either the ``local.conf`` or a recipe's append file to override or set the -recipe to point to the local directory on your disk to pull in the whole -source tree. +either ``local.conf`` or a recipe's append file to override or set the +recipe to point to the local directory from which to fetch the source. Source Control Managers (Optional) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3-54-g00ecf