mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
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" <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
d01f9c44ed
commit
f4d83e7685
|
@ -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 term "package" is sometimes used to refer to recipes. However, since
|
||||||
the word "package" is used for the packaged output from the OpenEmbedded
|
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.
|
using the term "package" when referring to recipes.
|
||||||
|
|
||||||
Classes
|
Classes
|
||||||
|
@ -256,7 +256,7 @@ development environment.
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
The
|
The
|
||||||
scripts/oe-setup-builddir
|
``scripts/oe-setup-builddir``
|
||||||
script uses the
|
script uses the
|
||||||
``$TEMPLATECONF``
|
``$TEMPLATECONF``
|
||||||
variable to determine which sample configuration files to locate.
|
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.
|
provide Metadata for the software, machine, and policies.
|
||||||
|
|
||||||
In general, there are three types of layer input. You can see them below
|
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 <overview-manual/concepts:openembedded build system concepts>`:
|
figure <overview-manual/concepts:openembedded build system concepts>`:
|
||||||
|
|
||||||
- *Metadata (.bb + Patches):* Software layers containing
|
- *Metadata (.bb + Patches):* Software layers containing
|
||||||
|
@ -420,14 +420,14 @@ build.
|
||||||
Distro Layer
|
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
|
distribution. Best practices dictate that you isolate these types of
|
||||||
configurations into their own layer. Settings you provide in
|
configurations into their own layer. Settings you provide in
|
||||||
``conf/distro/distro.conf`` override similar settings that BitBake finds
|
``conf/distro/distro.conf`` override similar settings that BitBake finds
|
||||||
in your ``conf/local.conf`` file in the :term:`Build Directory`.
|
in your ``conf/local.conf`` file in the :term:`Build Directory`.
|
||||||
|
|
||||||
The following list provides some explanation and references for what you
|
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
|
- *classes:* Class files (``.bbclass``) hold common functionality that
|
||||||
can be shared among recipes in the distribution. When your recipes
|
can be shared among recipes in the distribution. When your recipes
|
||||||
|
@ -454,7 +454,7 @@ typically find in the distribution layer:
|
||||||
BSP 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
|
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
|
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
|
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
|
In order for a BSP layer to be considered compliant with the Yocto
|
||||||
Project, it must meet some structural requirements.
|
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
|
the machine (``conf/machine/machine.conf``) and, of course, the layer
|
||||||
(``conf/layer.conf``).
|
(``conf/layer.conf``).
|
||||||
|
|
||||||
|
@ -477,18 +477,18 @@ formfactors, graphics support systems, and so forth.
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
While the figure shows several
|
While the figure shows several
|
||||||
recipes-\*
|
``recipes-*``
|
||||||
directories, not all these directories appear in all BSP layers.
|
directories, not all these directories appear in all BSP layers.
|
||||||
|
|
||||||
Software Layer
|
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
|
packages used during the build. This layer does not include Metadata
|
||||||
that is specific to the distribution or the machine, which are found in
|
that is specific to the distribution or the machine, which are found in
|
||||||
their respective layers.
|
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.
|
project needs.
|
||||||
|
|
||||||
Sources
|
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
|
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
|
: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
|
either ``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
|
recipe to point to the local directory from which to fetch the source.
|
||||||
source tree.
|
|
||||||
|
|
||||||
Source Control Managers (Optional)
|
Source Control Managers (Optional)
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
Loading…
Reference in New Issue
Block a user