summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-27 17:38:09 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commit424567d629b08785a6594d16427ee0fa8c31f384 (patch)
tree4985979745b1c5601f7a82c662042fb745bfd7db /documentation/ref-manual/ref-classes.rst
parent4bf6fc5281d1976ad7113c91a93995406cfab429 (diff)
downloadpoky-424567d629b08785a6594d16427ee0fa8c31f384.tar.gz
sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-classes.rst')
-rw-r--r--documentation/ref-manual/ref-classes.rst20
1 files changed, 10 insertions, 10 deletions
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 6449b49cd4..4b4f3bac5a 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -14,8 +14,8 @@ some default behavior.
14Any :term:`Metadata` usually found in a recipe can also be 14Any :term:`Metadata` usually found in a recipe can also be
15placed in a class file. Class files are identified by the extension 15placed in a class file. Class files are identified by the extension
16``.bbclass`` and are usually placed in a ``classes/`` directory beneath 16``.bbclass`` and are usually placed in a ``classes/`` directory beneath
17the ``meta*/`` directory found in the `Source 17the ``meta*/`` directory found in the :term:`Source Directory`.
18Directory <#source-directory>`__. Class files can also be pointed to by 18Class files can also be pointed to by
19:term:`BUILDDIR` (e.g. ``build/``) in the same way as 19:term:`BUILDDIR` (e.g. ``build/``) in the same way as
20``.conf`` files in the ``conf`` directory. Class files are searched for 20``.conf`` files in the ``conf`` directory. Class files are searched for
21in :term:`BBPATH` using the same method by which ``.conf`` 21in :term:`BBPATH` using the same method by which ``.conf``
@@ -555,7 +555,7 @@ used.
555 ``distutils`` class in their recipes. 555 ``distutils`` class in their recipes.
556 556
557- Extensions that use build systems based on ``setuptools3`` require 557- Extensions that use build systems based on ``setuptools3`` require
558 the ```setuptools3`` <#ref-classes-setuptools>`__ class in their 558 the :ref:`setuptools3 <ref-classes-setuptools>` class in their
559 recipes. 559 recipes.
560 560
561The ``distutils3*`` classes either inherit their corresponding 561The ``distutils3*`` classes either inherit their corresponding
@@ -592,8 +592,8 @@ ${WORKDIR}/${BPN}/{PV}/ See these variables for more information:
592:term:`PV`, 592:term:`PV`,
593 593
594For more information on the ``externalsrc`` class, see the comments in 594For more information on the ``externalsrc`` class, see the comments in
595``meta/classes/externalsrc.bbclass`` in the `Source 595``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`.
596Directory <#source-directory>`__. For information on how to use the 596For information on how to use the
597``externalsrc`` class, see the "`Building Software from an External 597``externalsrc`` class, see the "`Building Software from an External
598Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" 598Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__"
599section in the Yocto Project Development Tasks Manual. 599section in the Yocto Project Development Tasks Manual.
@@ -1733,8 +1733,8 @@ package-specific classes:
1733 1733
1734You can control the list of resulting package formats by using the 1734You can control the list of resulting package formats by using the
1735``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf`` 1735``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf``
1736configuration file, which is located in the `Build 1736configuration file, which is located in the :term:`Build Directory`.
1737Directory <#build-directory>`__. When defining the variable, you can 1737When defining the variable, you can
1738specify one or more package types. Since images are generated from 1738specify one or more package types. Since images are generated from
1739packages, a packaging class is needed to enable image generation. The 1739packages, a packaging class is needed to enable image generation. The
1740first class listed in this variable is used for image generation. 1740first class listed in this variable is used for image generation.
@@ -2181,8 +2181,8 @@ recipe are no longer needed. However, by default, the build system
2181preserves these files for inspection and possible debugging purposes. If 2181preserves these files for inspection and possible debugging purposes. If
2182you would rather have these files deleted to save disk space as the 2182you would rather have these files deleted to save disk space as the
2183build progresses, you can enable ``rm_work`` by adding the following to 2183build progresses, you can enable ``rm_work`` by adding the following to
2184your ``local.conf`` file, which is found in the `Build 2184your ``local.conf`` file, which is found in the :term:`Build Directory`.
2185Directory <#build-directory>`__. INHERIT += "rm_work" If you are 2185INHERIT += "rm_work" If you are
2186modifying and building source code out of the work directory for a 2186modifying and building source code out of the work directory for a
2187recipe, enabling ``rm_work`` will potentially result in your changes to 2187recipe, enabling ``rm_work`` will potentially result in your changes to
2188the source being lost. To exclude some recipes from having their work 2188the source being lost. To exclude some recipes from having their work
@@ -2565,7 +2565,7 @@ Other classes use the ``terminal`` class anywhere a separate terminal
2565session needs to be started. For example, the 2565session needs to be started. For example, the
2566:ref:`patch <ref-classes-patch>` class assuming 2566:ref:`patch <ref-classes-patch>` class assuming
2567:term:`PATCHRESOLVE` is set to "user", the 2567:term:`PATCHRESOLVE` is set to "user", the
2568```cml1`` <#ref-classes-cml1>`__ class, and the 2568:ref:`cml1 <ref-classes-cml1>` class, and the
2569:ref:`devshell <ref-classes-devshell>` class all use the ``terminal`` 2569:ref:`devshell <ref-classes-devshell>` class all use the ``terminal``
2570class. 2570class.
2571 2571