mirror of
https://git.yoctoproject.org/poky
synced 2026-06-01 00:59:48 +00:00
manuals: add missing references to classes
Sometimes fixing line length in modified paragraphs too. [YOCTO #14508] Reported-by: Quentin Schulz <foss@0leil.net> (From yocto-docs rev: 885b60f5540849bf19240a01a77efce1d1b5d9f0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
committed by
Richard Purdie
Richard Purdie
parent
7ecd9877e6
commit
55621c31f1
@@ -203,8 +203,9 @@ system and gives an overview of their function and contents.
|
||||
packages should be checked for libraries and renamed according to
|
||||
Debian library package naming.
|
||||
|
||||
The default value is "${PACKAGES}", which causes the debian class to
|
||||
act on all packages that are explicitly generated by the recipe.
|
||||
The default value is "${PACKAGES}", which causes the
|
||||
:ref:`debian <ref-classes-debian>` class to act on all packages that are
|
||||
explicitly generated by the recipe.
|
||||
|
||||
:term:`AUTOREV`
|
||||
When :term:`SRCREV` is set to the value of this variable, it specifies to
|
||||
@@ -576,9 +577,9 @@ system and gives an overview of their function and contents.
|
||||
``quilt-native``, which is a copy of Quilt built to run on the build
|
||||
system; "crosses" such as ``gcc-cross``, which is a compiler built to
|
||||
run on the build machine but produces binaries that run on the target
|
||||
:term:`MACHINE`; "nativesdk", which targets the SDK
|
||||
machine instead of :term:`MACHINE`; and "mulitlibs" in the form
|
||||
"``multilib:``\ multilib_name".
|
||||
:term:`MACHINE`; ":ref:`nativesdk <ref-classes-nativesdk>`", which
|
||||
targets the SDK machine instead of :term:`MACHINE`; and "mulitlibs" in
|
||||
the form "``multilib:``\ multilib_name".
|
||||
|
||||
To build a different variant of the recipe with a minimal amount of
|
||||
code, it usually is as simple as adding the following to your recipe::
|
||||
@@ -906,7 +907,7 @@ system and gives an overview of their function and contents.
|
||||
The toolchain binary prefix used for native recipes. The OpenEmbedded
|
||||
build system uses the :term:`BUILD_PREFIX` value to set the
|
||||
:term:`TARGET_PREFIX` when building for
|
||||
``native`` recipes.
|
||||
:ref:`native <ref-classes-native>` recipes.
|
||||
|
||||
:term:`BUILD_STRIP`
|
||||
Specifies the command to be used to strip debugging symbols from
|
||||
@@ -917,7 +918,7 @@ system and gives an overview of their function and contents.
|
||||
:term:`BUILD_SYS`
|
||||
Specifies the system, including the architecture and the operating
|
||||
system, to use when building for the build host (i.e. when building
|
||||
``native`` recipes).
|
||||
:ref:`native <ref-classes-native>` recipes).
|
||||
|
||||
The OpenEmbedded build system automatically sets this variable based
|
||||
on :term:`BUILD_ARCH`,
|
||||
@@ -1417,8 +1418,10 @@ system and gives an overview of their function and contents.
|
||||
:term:`COPYLEFT_RECIPE_TYPES`
|
||||
A space-separated list of recipe types to include in the source
|
||||
archived by the :ref:`archiver <ref-classes-archiver>` class.
|
||||
Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``,
|
||||
``crosssdk``, and ``cross-canadian``.
|
||||
Recipe types are ``target``, :ref:`native <ref-classes-native>`,
|
||||
:ref:`nativesdk <ref-classes-nativesdk>`,
|
||||
:ref:`cross <ref-classes-cross>`, :ref:`crosssdk <ref-classes-crosssdk>`,
|
||||
and :ref:`cross-canadian <ref-classes-cross-canadian>`.
|
||||
|
||||
The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES`
|
||||
is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
|
||||
@@ -1751,9 +1754,8 @@ system and gives an overview of their function and contents.
|
||||
:term:`DEPLOY_DIR_DEB`
|
||||
Points to the area that the OpenEmbedded build system uses to place
|
||||
Debian packages that are ready to be used outside of the build
|
||||
system. This variable applies only when
|
||||
:term:`PACKAGE_CLASSES` contains
|
||||
"package_deb".
|
||||
system. This variable applies only when :term:`PACKAGE_CLASSES` contains
|
||||
":ref:`package_deb <ref-classes-package_deb>`".
|
||||
|
||||
The BitBake configuration file initially defines the
|
||||
:term:`DEPLOY_DIR_DEB` variable as a sub-folder of
|
||||
@@ -1794,9 +1796,8 @@ system and gives an overview of their function and contents.
|
||||
:term:`DEPLOY_DIR_IPK`
|
||||
Points to the area that the OpenEmbedded build system uses to place
|
||||
IPK packages that are ready to be used outside of the build system.
|
||||
This variable applies only when
|
||||
:term:`PACKAGE_CLASSES` contains
|
||||
"package_ipk".
|
||||
This variable applies only when :term:`PACKAGE_CLASSES` contains
|
||||
":ref:`package_ipk <ref-classes-package_ipk>`".
|
||||
|
||||
The BitBake configuration file initially defines this variable as a
|
||||
sub-folder of :term:`DEPLOY_DIR`::
|
||||
@@ -1814,9 +1815,8 @@ system and gives an overview of their function and contents.
|
||||
:term:`DEPLOY_DIR_RPM`
|
||||
Points to the area that the OpenEmbedded build system uses to place
|
||||
RPM packages that are ready to be used outside of the build system.
|
||||
This variable applies only when
|
||||
:term:`PACKAGE_CLASSES` contains
|
||||
"package_rpm".
|
||||
This variable applies only when :term:`PACKAGE_CLASSES` contains
|
||||
":ref:`package_rpm <ref-classes-package_rpm>`".
|
||||
|
||||
The BitBake configuration file initially defines this variable as a
|
||||
sub-folder of :term:`DEPLOY_DIR`::
|
||||
@@ -1834,9 +1834,8 @@ system and gives an overview of their function and contents.
|
||||
:term:`DEPLOY_DIR_TAR`
|
||||
Points to the area that the OpenEmbedded build system uses to place
|
||||
tarballs that are ready to be used outside of the build system. This
|
||||
variable applies only when
|
||||
:term:`PACKAGE_CLASSES` contains
|
||||
"package_tar".
|
||||
variable applies only when :term:`PACKAGE_CLASSES` contains
|
||||
":ref:`package_tar <ref-classes-package_tar>`".
|
||||
|
||||
The BitBake configuration file initially defines this variable as a
|
||||
sub-folder of :term:`DEPLOY_DIR`::
|
||||
@@ -1993,11 +1992,11 @@ system and gives an overview of their function and contents.
|
||||
|
||||
:term:`DISTRO_FEATURES_FILTER_NATIVESDK`
|
||||
Specifies a list of features that if present in the target
|
||||
:term:`DISTRO_FEATURES` value should be
|
||||
included in :term:`DISTRO_FEATURES` when building nativesdk recipes. This
|
||||
variable is used in addition to the features filtered using the
|
||||
:term:`DISTRO_FEATURES_NATIVESDK`
|
||||
variable.
|
||||
:term:`DISTRO_FEATURES` value should be included in
|
||||
:term:`DISTRO_FEATURES` when building
|
||||
:ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used
|
||||
in addition to the features filtered using the
|
||||
:term:`DISTRO_FEATURES_NATIVESDK` variable.
|
||||
|
||||
:term:`DISTRO_FEATURES_NATIVE`
|
||||
Specifies a list of features that should be included in
|
||||
@@ -2010,10 +2009,9 @@ system and gives an overview of their function and contents.
|
||||
:term:`DISTRO_FEATURES_NATIVESDK`
|
||||
Specifies a list of features that should be included in
|
||||
:term:`DISTRO_FEATURES` when building
|
||||
nativesdk recipes. This variable is used in addition to the features
|
||||
filtered using the
|
||||
:term:`DISTRO_FEATURES_FILTER_NATIVESDK`
|
||||
variable.
|
||||
:ref:`nativesdk <ref-classes-nativesdk>` recipes. This variable is used
|
||||
in addition to the features filtered using the
|
||||
:term:`DISTRO_FEATURES_FILTER_NATIVESDK` variable.
|
||||
|
||||
:term:`DISTRO_NAME`
|
||||
The long name of the distribution. For information on the short name
|
||||
@@ -4124,12 +4122,12 @@ system and gives an overview of their function and contents.
|
||||
|
||||
:term:`KERNEL_CLASSES`
|
||||
A list of classes defining kernel image types that the
|
||||
:ref:`kernel <ref-classes-kernel>` class should inherit. You
|
||||
typically append this variable to enable extended image types. An
|
||||
example is the "kernel-fitimage", which enables fitImage support and
|
||||
resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. You can register
|
||||
custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this
|
||||
variable.
|
||||
:ref:`kernel <ref-classes-kernel>` class should inherit. You typically
|
||||
append this variable to enable extended image types. An example is
|
||||
":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`", which enables
|
||||
fitImage support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
|
||||
You can register custom kernel image types with the
|
||||
:ref:`kernel <ref-classes-kernel>` class using this variable.
|
||||
|
||||
:term:`KERNEL_DEBUG_TIMESTAMPS`
|
||||
If set to "1", enables timestamping functionality during building
|
||||
@@ -4949,16 +4947,18 @@ system and gives an overview of their function and contents.
|
||||
|
||||
.. note::
|
||||
|
||||
The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation is
|
||||
historical and comes from a time when ``nativesdk`` was a suffix
|
||||
rather than a prefix on the recipe name. When ``nativesdk`` was turned
|
||||
The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation
|
||||
is historical and comes from a time when
|
||||
":ref:`nativesdk <ref-classes-nativesdk>`"
|
||||
was a suffix rather than a prefix on the recipe name. When
|
||||
":ref:`nativesdk <ref-classes-nativesdk>`" was turned
|
||||
into a prefix, it made sense to set :term:`MLPREFIX` for it as well.
|
||||
|
||||
To help understand when :term:`MLPREFIX` might be needed, consider when
|
||||
:term:`BBCLASSEXTEND` is used to provide a
|
||||
``nativesdk`` version of a recipe in addition to the target version.
|
||||
If that recipe declares build-time dependencies on tasks in other
|
||||
recipes by using :term:`DEPENDS`, then a dependency on
|
||||
:ref:`nativesdk <ref-classes-nativesdk>` version of a recipe in addition
|
||||
to the target version. If that recipe declares build-time dependencies
|
||||
on tasks in other recipes by using :term:`DEPENDS`, then a dependency on
|
||||
"foo" will automatically get rewritten to a dependency on
|
||||
"nativesdk-foo". However, dependencies like the following will not
|
||||
get rewritten automatically::
|
||||
@@ -5406,12 +5406,13 @@ system and gives an overview of their function and contents.
|
||||
OpenEmbedded build system uses when packaging data.
|
||||
|
||||
You can provide one or more of the following arguments for the
|
||||
variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk
|
||||
package_tar"
|
||||
variable::
|
||||
|
||||
PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar"
|
||||
|
||||
.. note::
|
||||
|
||||
While it is a legal option, the ``package_tar``
|
||||
While it is a legal option, the :ref:`package_tar <ref-classes-package_tar>`
|
||||
class has limited functionality due to no support for package
|
||||
dependencies by that backend. Therefore, it is recommended that
|
||||
you do not use it.
|
||||
@@ -5925,8 +5926,9 @@ system and gives an overview of their function and contents.
|
||||
:term:`PIXBUF_PACKAGES`
|
||||
When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
|
||||
class, this variable identifies packages that contain the pixbuf
|
||||
loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache``
|
||||
class assumes that the loaders are in the recipe's main package (i.e.
|
||||
loaders used with ``gdk-pixbuf``. By default, the
|
||||
:ref:`pixbufcache <ref-classes-pixbufcache>` class assumes that
|
||||
the loaders are in the recipe's main package (i.e.
|
||||
``${``\ :term:`PN`\ ``}``). Use this variable if the
|
||||
loaders you need are in a package other than that main package.
|
||||
|
||||
@@ -6358,7 +6360,7 @@ system and gives an overview of their function and contents.
|
||||
|
||||
:term:`PYTHON_PN`
|
||||
When used by recipes that inherit the
|
||||
:ref:`setuptools3 <ref-classes-setuptools3>` classe, specifies the
|
||||
:ref:`setuptools3 <ref-classes-setuptools3>` class, specifies the
|
||||
major Python version being built. For Python 3.x, :term:`PYTHON_PN` would
|
||||
be "python3". You do not have to set this variable as the
|
||||
OpenEmbedded build system automatically sets it for you.
|
||||
@@ -6562,10 +6564,9 @@ system and gives an overview of their function and contents.
|
||||
for the same recipe, the :term:`REQUIRED_VERSION` value applies.
|
||||
|
||||
:term:`RM_WORK_EXCLUDE`
|
||||
With ``rm_work`` enabled, this variable specifies a list of recipes
|
||||
whose work directories should not be removed. See the
|
||||
":ref:`ref-classes-rm-work`" section for more
|
||||
details.
|
||||
With :ref:`rm_work <ref-classes-rm-work>` enabled, this variable
|
||||
specifies a list of recipes whose work directories should not be removed.
|
||||
See the ":ref:`ref-classes-rm-work`" section for more details.
|
||||
|
||||
:term:`ROOT_HOME`
|
||||
Defines the root home directory. By default, this directory is set as
|
||||
@@ -6830,9 +6831,9 @@ system and gives an overview of their function and contents.
|
||||
|
||||
:term:`SDK_DEPLOY`
|
||||
The directory set up and used by the
|
||||
:ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
|
||||
the SDK is deployed. The ``populate_sdk_base`` class defines
|
||||
:term:`SDK_DEPLOY` as follows::
|
||||
:ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which the
|
||||
SDK is deployed. The :ref:`populate_sdk_base <ref-classes-populate-sdk>`
|
||||
class defines :term:`SDK_DEPLOY` as follows::
|
||||
|
||||
SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
|
||||
|
||||
@@ -6950,7 +6951,8 @@ system and gives an overview of their function and contents.
|
||||
:term:`SDK_DIR` variable for more information.
|
||||
|
||||
:term:`SDK_PREFIX`
|
||||
The toolchain binary prefix used for ``nativesdk`` recipes. The
|
||||
The toolchain binary prefix used for
|
||||
:ref:`nativesdk <ref-classes-nativesdk>` recipes. The
|
||||
OpenEmbedded build system uses the :term:`SDK_PREFIX` value to set the
|
||||
:term:`TARGET_PREFIX` when building
|
||||
``nativesdk`` recipes. The default value is "${SDK_SYS}-".
|
||||
@@ -7761,7 +7763,7 @@ system and gives an overview of their function and contents.
|
||||
|
||||
Some recipes build binaries that can run on the target system but
|
||||
those binaries in turn generate code for another different system
|
||||
(e.g. cross-canadian recipes). Using terminology from GNU, the
|
||||
(e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). Using terminology from GNU, the
|
||||
primary system is referred to as the "HOST" and the secondary, or
|
||||
different, system is referred to as the "TARGET". Thus, the binaries
|
||||
run on the "HOST" system and generate binaries for the "TARGET"
|
||||
@@ -8205,8 +8207,8 @@ system and gives an overview of their function and contents.
|
||||
- For native recipes, the build system sets the variable to the
|
||||
value of :term:`BUILD_PREFIX`.
|
||||
|
||||
- For native SDK recipes (``nativesdk``), the build system sets the
|
||||
variable to the value of :term:`SDK_PREFIX`.
|
||||
- For native SDK recipes (:ref:`nativesdk <ref-classes-nativesdk>`),
|
||||
the build system sets the variable to the value of :term:`SDK_PREFIX`.
|
||||
|
||||
:term:`TARGET_SYS`
|
||||
Specifies the system, including the architecture and the operating
|
||||
@@ -8817,8 +8819,9 @@ system and gives an overview of their function and contents.
|
||||
:term:`UBOOT_MKIMAGE_DTCOPTS`
|
||||
Options for the device tree compiler passed to mkimage '-D'
|
||||
feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
|
||||
If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not
|
||||
pass the ``-D`` option to mkimage.
|
||||
If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then
|
||||
:ref:`kernel-fitimage <ref-classes-kernel-fitimage>` will not pass the
|
||||
``-D`` option to mkimage.
|
||||
|
||||
:term:`UBOOT_MKIMAGE_KERNEL_TYPE`
|
||||
Specifies the type argument for the kernel as passed to ``uboot-mkimage``.
|
||||
|
||||
Reference in New Issue
Block a user