From patchwork Tue Nov 23 18:12:37 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 1428 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 86FE0C433F5 for ; Tue, 23 Nov 2021 18:12:50 +0000 (UTC) Received: from relay10.mail.gandi.net (relay10.mail.gandi.net [217.70.178.230]) by mx.groups.io with SMTP id smtpd.web09.15242.1637691169089928384 for ; Tue, 23 Nov 2021 10:12:49 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: bootlin.com, ip: 217.70.178.230, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by relay10.mail.gandi.net (Postfix) with ESMTPSA id E7D85240006; Tue, 23 Nov 2021 18:12:46 +0000 (UTC) From: Michael Opdenacker To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 1/3] migration-guides: add more class references Date: Tue, 23 Nov 2021 19:12:37 +0100 Message-Id: <20211123181239.2057168-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> References: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 23 Nov 2021 18:12:50 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2181 Signed-off-by: Michael Opdenacker --- documentation/migration-guides/migration-1.5.rst | 3 ++- documentation/migration-guides/migration-1.7.rst | 6 ++++-- documentation/migration-guides/migration-2.1.rst | 6 +++--- documentation/migration-guides/migration-2.2.rst | 2 +- documentation/migration-guides/migration-2.3.rst | 2 +- documentation/migration-guides/migration-2.4.rst | 2 +- documentation/migration-guides/migration-2.5.rst | 8 ++++---- documentation/migration-guides/migration-3.0.rst | 4 ++-- documentation/migration-guides/migration-3.1.rst | 4 ++-- documentation/migration-guides/migration-3.2.rst | 2 +- documentation/migration-guides/migration-3.3.rst | 2 +- 11 files changed, 22 insertions(+), 19 deletions(-) diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 11c821265c..15b0b43092 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst @@ -95,7 +95,8 @@ The following changes have been made to the package QA checks: this file within :ref:`ref-tasks-install` if "make install" is installing it. -- If you are using the ``buildhistory`` class, the check for the package +- If you are using the :ref:`buildhistory ` class, + the check for the package version going backwards is now controlled using a standard QA check. Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values and still wish to have this check performed, you should add diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index 8c642da202..88a6855d50 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst @@ -43,7 +43,8 @@ The following :ref:`autotools ` class changes occurred: - *A separate build directory is now used by default:* The - ``autotools`` class has been changed to use a directory for building + :ref:`autotools ` class has been + changed to use a directory for building (:term:`B`), which is separate from the source directory (:term:`S`). This is commonly referred to as ``B != S``, or an out-of-tree build. @@ -54,7 +55,8 @@ occurred: manner, you will need to either patch the software so that it can build separately, or you will need to change the recipe to inherit the :ref:`autotools-brokensep ` class - instead of the ``autotools`` or ``autotools_stage`` classes. + instead of the :ref:`autotools ` + or ``autotools_stage`` classes. - The ``--foreign`` option is no longer passed to ``automake`` when running ``autoconf``: This option tells ``automake`` that a diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index 3135d69caa..eb29694bb5 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst @@ -106,12 +106,12 @@ as was previously assumed. Rather, the value changes based on whether large file support is enabled. For most software that uses ``autoconf``, this change should not be a problem. However, if you have a recipe that bypasses the standard :ref:`ref-tasks-configure` task -from the ``autotools`` class and the software the recipe is building +from the :ref:`autotools ` class and the software the recipe is building uses a very old version of ``autoconf``, the recipe might be incapable of determining the correct size of ``off_t`` during ``do_configure``. The best course of action is to patch the software as necessary to allow -the default implementation from the ``autotools`` class to work such +the default implementation from the :ref:`autotools ` class to work such that ``autoreconf`` succeeds and produces a working configure script, and to remove the overridden ``do_configure`` task such that the default implementation does get used. @@ -262,7 +262,7 @@ The following changes have been made for the Poky distribution: With this class enabled, a tarball containing a pre-built C library is downloaded at the start of the build. - The ``uninative`` class is enabled through the + The :ref:`uninative ` class is enabled through the ``meta/conf/distro/include/yocto-uninative.inc`` file, which for those not using the Poky distribution, can include to easily enable the same functionality. diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index cbdc6a739e..c063deb44b 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst @@ -439,7 +439,7 @@ The following miscellaneous changes have occurred: - ``packagegroup-core-tools-testapps``: Removed Piglit. -- ``image.bbclass``: Renamed COMPRESS(ION) to CONVERSION. This change +- :ref:`image.bbclass `: Renamed COMPRESS(ION) to CONVERSION. This change means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index b79bc541c5..0b6b33d2cb 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst @@ -50,7 +50,7 @@ Consider the following: post-installation script that is installed by a function added to :term:`SYSROOT_PREPROCESS_FUNCS`. - For an example, see the ``pixbufcache`` class in ``meta/classes/`` in + For an example, see the :ref:`pixbufcache ` class in ``meta/classes/`` in the :ref:`overview-manual/development-environment:yocto project source repositories`. .. note:: diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index ae1a212b5d..ef5f32e6ef 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst @@ -273,7 +273,7 @@ The following are additional changes: a single commit per build rather than one commit per subdirectory in the repository. This behavior assumes the commits are enabled with :term:`BUILDHISTORY_COMMIT` = "1", which - is typical. Previously, the ``buildhistory`` class made one commit + is typical. Previously, the :ref:`buildhistory ` class made one commit per subdirectory in the repository in order to make it easier to see the changes for a particular subdirectory. To view a particular change, specify that subdirectory as the last parameter on the diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index 79f804fa1d..bd75522773 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst @@ -137,7 +137,7 @@ The following are BitBake changes: - Several explicit "run this task for all recipes in the dependency tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, and the ``*all`` tasks provided by the ``distrodata`` and - ``archiver`` classes). There is a BitBake option to complete this for + :ref:`archiver ` classes). There is a BitBake option to complete this for any arbitrary task. For example:: bitbake -c fetchall @@ -187,7 +187,7 @@ Miscellaneous Changes The following are additional changes: -- The ``kernel`` class supports building packages for multiple kernels. +- The :ref:`kernel ` class supports building packages for multiple kernels. If your kernel recipe or ``.bbappend`` file mentions packaging at all, you should replace references to the kernel in package names with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable @@ -195,7 +195,7 @@ The following are additional changes: ``RDEPENDS_kernel-base = ""`` you can avoid warnings using ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. -- The ``buildhistory`` class commits changes to the repository by +- The :ref:`buildhistory ` class commits changes to the repository by default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. If you want to disable commits you need to set ``BUILDHISTORY_COMMIT = "0"`` in your configuration. @@ -207,7 +207,7 @@ The following are additional changes: maintains a full-featured BSP in the ``meta-ti`` layer. This rename avoids the previous name clash that existed between the two BSPs. -- The ``update-alternatives`` class no longer works with SysV ``init`` +- The :ref:`update-alternatives ` class no longer works with SysV ``init`` scripts because this usage has been problematic. Also, the ``sysklogd`` recipe no longer uses ``update-alternatives`` because it is incompatible with other implementations. diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 9a5f5714bd..610298bda6 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst @@ -47,7 +47,7 @@ The following recipes have been removed. - ``core-image-lsb-sdk``: Part of removed LSB support. - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` - recipe and ``cve-check`` class. + recipe and :ref:`cve-check ` class. - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is an adequate and maintained alternative. @@ -142,7 +142,7 @@ CVE Checking ------------ ``cve-check-tool`` has been functionally replaced by a new -``cve-update-db`` recipe and functionality built into the ``cve-check`` +``cve-update-db`` recipe and functionality built into the :ref:`cve-check ` class. The result uses NVD JSON data feeds rather than the deprecated XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, and makes other improvements. diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index 80b8f6baa5..cb0296717e 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst @@ -125,7 +125,7 @@ renamed to ``features_check``; the ``distro_features_check`` class still exists but generates a warning and redirects to the new class. In preparation for a future removal of the old class it is recommended that you update recipes currently inheriting ``distro_features_check`` to -inherit ``features_check`` instead. +inherit :ref:`features_check ` instead. .. _migration-3.1-removed-classes: @@ -241,7 +241,7 @@ circumstances: does not inherit the new ``mime-xdg`` class - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` - but does not inherit the ``mime`` class + but does not inherit the :ref:`mime ` class .. _migration-3.1-x86-live-wic: diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index a940f23238..d593effe97 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst @@ -209,7 +209,7 @@ deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` ``do_deploy`` as implemented in the :ref:`deploy ` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. -Most recipes and classes that inherit the ``deploy`` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. +Most recipes and classes that inherit the :ref:`deploy ` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. .. _migration-3.2-nativesdk-sdk-provides-dummy: diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index 28857e820b..f065a17e68 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst @@ -64,7 +64,7 @@ New ``python3targetconfig`` class A new :ref:`python3targetconfig ` class has been created for situations where you would previously have inherited the -``python3native`` class but need access to target configuration data (such as +:ref:`python3native ` class but need access to target configuration data (such as correct installation directories). Recipes where this situation applies should be changed to inherit ``python3targetconfig`` instead of ``python3native``. This also adds a dependency on target ``python3``, so it should only be used where From patchwork Tue Nov 23 18:12:38 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 1430 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B555C433F5 for ; Tue, 23 Nov 2021 18:12:59 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web08.14975.1637691177790467758 for ; Tue, 23 Nov 2021 10:12:58 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 851301C0003; Tue, 23 Nov 2021 18:12:48 +0000 (UTC) From: Michael Opdenacker To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 2/3] ref-manual: add more class references Date: Tue, 23 Nov 2021 19:12:38 +0100 Message-Id: <20211123181239.2057168-3-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> References: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 23 Nov 2021 18:12:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2184 Signed-off-by: Michael Opdenacker --- documentation/ref-manual/classes.rst | 4 +-- documentation/ref-manual/structure.rst | 2 +- documentation/ref-manual/tasks.rst | 4 +-- documentation/ref-manual/variables.rst | 48 ++++++++++++-------------- 4 files changed, 28 insertions(+), 30 deletions(-) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 5bc4472e34..95dc185e62 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -570,11 +570,11 @@ be performed using the .. note:: The user and group operations added using the - extrausers + :ref:`extrausers ` class are not tied to a specific recipe outside of the recipe for the image. Thus, the operations can be performed across the image as a whole. Use the - useradd + :ref:`useradd ` class to add user and group configuration to a specific recipe. Here is an example that uses this class in an image recipe:: diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 5f00edb06c..5d2e3a86ef 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -231,7 +231,7 @@ is available via the :term:`TOPDIR` variable. ----------------------- The OpenEmbedded build system creates this directory when you enable -build history via the ``buildhistory`` class file. The directory +build history via the :ref:`buildhistory ` class file. The directory organizes build information into image, packages, and SDK subdirectories. For information on the build history feature, see the ":ref:`dev-manual/common-tasks:maintaining build output quality`" diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 299969dea4..8d563714a1 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -80,7 +80,7 @@ task runs with the current working directory set to Recipes implementing this task should inherit the :ref:`deploy ` class and should write the output to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be -confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up +confused with ``${DEPLOY_DIR}``. The :ref:`deploy ` class sets up ``do_deploy`` as a shared state (sstate) task that can be accelerated through sstate use. The sstate mechanism takes care of copying the output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. @@ -102,7 +102,7 @@ Adding ``do_deploy`` after other tasks works the same way. .. note:: You do not need to add ``before do_build`` to the ``addtask`` command - (though it is harmless), because the ``base`` class contains the following:: + (though it is harmless), because the :ref:`base ` class contains the following:: do_build[recrdeptask] += "do_deploy" diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 26b56e145c..c30110d916 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -773,7 +773,7 @@ system and gives an overview of their function and contents. :ref:`binconfig-disabled ` class, this variable specifies binary configuration scripts to disable in favor of using ``pkg-config`` to query the information. The - ``binconfig-disabled`` class will modify the specified scripts to + :ref:`binconfig-disabled ` class will modify the specified scripts to return an error so that calls to them can be easily found and replaced. @@ -941,13 +941,13 @@ system and gives an overview of their function and contents. When inheriting the :ref:`buildhistory ` class, this variable specifies whether or not to commit the build history output in a local Git repository. If set to "1", this local - repository will be maintained automatically by the ``buildhistory`` + repository will be maintained automatically by the :ref:`buildhistory ` class and a commit will be created on every build for changes to each top-level subdirectory of the build history output (images, packages, and sdk). If you want to track changes to build history over time, you should set this value to "1". - By default, the ``buildhistory`` class does not commit the build + By default, the :ref:`buildhistory ` class does not commit the build history output in a local Git repository:: BUILDHISTORY_COMMIT ?= "0" @@ -964,7 +964,7 @@ system and gives an overview of their function and contents. email@host". Providing an email address or host that is not valid does not produce an error. - By default, the ``buildhistory`` class sets the variable as follows:: + By default, the :ref:`buildhistory ` class sets the variable as follows:: BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory " @@ -972,9 +972,9 @@ system and gives an overview of their function and contents. When inheriting the :ref:`buildhistory ` class, this variable specifies the directory in which build history information is kept. For more information on how the variable works, - see the ``buildhistory.class``. + see the ``buildhistory.bbclass`` file. - By default, the ``buildhistory`` class sets the directory as follows:: + By default, the :ref:`buildhistory ` class sets the directory as follows:: BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" @@ -1001,7 +1001,7 @@ system and gives an overview of their function and contents. This saves one file per task and lists the SHA-256 checksums for each file staged (i.e. the output of the task). - By default, the ``buildhistory`` class enables the following + By default, the :ref:`buildhistory ` class enables the following features:: BUILDHISTORY_FEATURES ?= "image package sdk" @@ -1017,7 +1017,7 @@ system and gives an overview of their function and contents. any file. Specifying an invalid path does not produce an error. Consequently, you can include files that might not always be present. - By default, the ``buildhistory`` class provides paths to the + By default, the :ref:`buildhistory ` class provides paths to the following files:: BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" @@ -1030,7 +1030,7 @@ system and gives an overview of their function and contents. useful when build history is populated from multiple sources that may not all use the same top level directory. - By default, the ``buildhistory`` class sets the variable as follows:: + By default, the :ref:`buildhistory ` class sets the variable as follows:: BUILDHISTORY_PATH_PREFIX_STRIP ?= "" @@ -1049,7 +1049,7 @@ system and gives an overview of their function and contents. that you have set up manually using ``git remote`` within the local repository. - By default, the ``buildhistory`` class sets the variable as follows:: + By default, the :ref:`buildhistory ` class sets the variable as follows:: BUILDHISTORY_PUSH_REPO ?= "" @@ -1323,7 +1323,7 @@ system and gives an overview of their function and contents. The default value, which is "CLOSED Proprietary", for :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. + is inherited by the :ref:`archiver ` class. :term:`COPYLEFT_LICENSE_INCLUDE` A space-separated list of licenses to include in the source archived @@ -1334,7 +1334,7 @@ system and gives an overview of their function and contents. The default value is set by the :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. The default value includes + is inherited by the :ref:`archiver ` class. The default value includes "GPL*", "LGPL*", and "AGPL*". :term:`COPYLEFT_PN_EXCLUDE` @@ -1349,7 +1349,7 @@ system and gives an overview of their function and contents. The default value, which is "" indicating to not explicitly exclude any recipes by name, for :term:`COPYLEFT_PN_EXCLUDE` is set by the :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. + is inherited by the :ref:`archiver ` class. :term:`COPYLEFT_PN_INCLUDE` A list of recipes to include in the source archived by the @@ -1363,7 +1363,7 @@ system and gives an overview of their function and contents. The default value, which is "" indicating to not explicitly include any recipes by name, for :term:`COPYLEFT_PN_INCLUDE` is set by the :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. + is inherited by the :ref:`archiver ` class. :term:`COPYLEFT_RECIPE_TYPES` A space-separated list of recipe types to include in the source @@ -1373,7 +1373,7 @@ system and gives an overview of their function and contents. The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` is set by the :ref:`copyleft_filter ` - class, which is inherited by the ``archiver`` class. + class, which is inherited by the :ref:`archiver ` class. :term:`COPY_LIC_DIRS` If set to "1" along with the @@ -1805,11 +1805,11 @@ system and gives an overview of their function and contents. :term:`DEPLOYDIR` When inheriting the :ref:`deploy ` class, the :term:`DEPLOYDIR` points to a temporary work area for deployed files that - is set in the ``deploy`` class as follows:: + is set in the :ref:`deploy ` class as follows:: DEPLOYDIR = "${WORKDIR}/deploy-${PN}" - Recipes inheriting the ``deploy`` class should copy files to be + Recipes inheriting the :ref:`deploy ` class should copy files to be deployed into :term:`DEPLOYDIR`, and the class will take care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. @@ -2293,7 +2293,7 @@ system and gives an overview of their function and contents. group configurations to a specific recipe. The set list of commands you can configure using the - :term:`EXTRA_USERS_PARAMS` is shown in the ``extrausers`` class. These + :term:`EXTRA_USERS_PARAMS` is shown in the :ref:`extrausers ` class. These commands map to the normal Unix commands of the same names:: # EXTRA_USERS_PARAMS = "\ @@ -2628,7 +2628,7 @@ system and gives an overview of their function and contents. :term:`FONT_PACKAGES` When inheriting the :ref:`fontcache ` class, this variable identifies packages containing font files that need to - be cached by Fontconfig. By default, the ``fontcache`` class assumes + be cached by Fontconfig. By default, the :ref:`fontcache ` class assumes that fonts are in the recipe's main package (i.e. ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you need are in a package other than that main package. @@ -3890,7 +3890,7 @@ system and gives an overview of their function and contents. typically append this variable to enable extended image types. An example is the "kernel-fitimage", which enables fitImage support and resides in ``meta/classes/kernel-fitimage.bbclass``. You can register - custom kernel image types with the ``kernel`` class using this + custom kernel image types with the :ref:`kernel ` class using this variable. :term:`KERNEL_DEVICETREE` @@ -4285,7 +4285,7 @@ system and gives an overview of their function and contents. that the :ref:`debian ` class applies its naming policy to given a recipe that packages multiple libraries. - This variable works in conjunction with the ``debian`` class. + This variable works in conjunction with the :ref:`debian ` class. :term:`LIC_FILES_CHKSUM` Checksums of the license text in the recipe source code. @@ -4910,9 +4910,7 @@ system and gives an overview of their function and contents. See the ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory` for details on how this class - applies these additional sed command arguments. For general - information on the ``binconfig`` class, see the - ":ref:`binconfig.bbclass `" section. + applies these additional sed command arguments. :term:`OE_IMPORTS` An internal variable used to tell the OpenEmbedded build system what @@ -6009,7 +6007,7 @@ system and gives an overview of their function and contents. names used when installing the Python headers and libraries in sysroot (e.g. ``.../python3.3m/...``). - Recipes that inherit the ``distutils3`` class during cross-builds also + Recipes that inherit the :ref:`distutils3 ` class during cross-builds also use this variable to locate the headers and libraries of the appropriate Python that the extension is targeting. From patchwork Tue Nov 23 18:12:39 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 1429 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6C51DC433EF for ; Tue, 23 Nov 2021 18:12:53 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web10.15174.1637691172708926857 for ; Tue, 23 Nov 2021 10:12:53 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: bootlin.com, ip: 217.70.183.198, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by relay6-d.mail.gandi.net (Postfix) with ESMTPSA id 3DA20C000D; Tue, 23 Nov 2021 18:12:51 +0000 (UTC) From: Michael Opdenacker To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 3/3] misc manuals: add further class references Date: Tue, 23 Nov 2021 19:12:39 +0100 Message-Id: <20211123181239.2057168-4-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> References: <20211123181239.2057168-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Tue, 23 Nov 2021 18:12:53 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2182 Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 32 ++++++++++------------ documentation/overview-manual/concepts.rst | 2 +- documentation/test-manual/intro.rst | 2 +- 3 files changed, 17 insertions(+), 19 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 9611a4f206..5ac347d18b 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -938,7 +938,8 @@ a recipe and using :term:`EXTRA_IMAGE_FEATURES` from within your :term:`Build Directory`. To understand how these features work, the best reference is -``meta/classes/image.bbclass``. This class lists out the available +:ref:`meta/classes/image.bbclass `. +This class lists out the available :term:`IMAGE_FEATURES` of which most map to package groups while some, such as ``debug-tweaks`` and ``read-only-rootfs``, resolve as general configuration settings. @@ -2113,7 +2114,7 @@ statement that essentially identifies itself as being able to provide PROVIDES += "${@ "virtual/kernel" if (d.getVar("KERNEL_PACKAGE_NAME") == "kernel") else "" }" -Any recipe that inherits the ``kernel`` class is +Any recipe that inherits the :ref:`kernel ` class is going to utilize a :term:`PROVIDES` statement that identifies that recipe as being able to provide the ``virtual/kernel`` item. @@ -2459,7 +2460,7 @@ sometimes you have no choice. The easiest solution is to create a recipe that uses the :ref:`bin_package ` class and to be sure that you are using default locations for build artifacts. -In most cases, the ``bin_package`` class handles "skipping" the +In most cases, the :ref:`bin_package ` class handles "skipping" the configure and compile steps as well as sets things up to grab packages from the appropriate area. In particular, this class sets ``noexec`` on both the :ref:`ref-tasks-configure` @@ -2467,7 +2468,7 @@ and :ref:`ref-tasks-compile` tasks, sets ``FILES:${PN}`` to "/" so that it picks up all files, and sets up a :ref:`ref-tasks-install` task, which effectively copies all files from ``${S}`` to ``${D}``. The -``bin_package`` class works well when the files extracted into ``${S}`` +:ref:`bin_package ` class works well when the files extracted into ``${S}`` are already laid out in the way they should be laid out on the target. For more information on these variables, see the :term:`FILES`, @@ -2492,7 +2493,7 @@ Reference Manual's variable glossary. section in the Yocto Project Overview and Concepts Manual for more information. -If you cannot use the ``bin_package`` class, you need to be sure you are +If you cannot use the :ref:`bin_package ` class, you need to be sure you are doing the following: - Create a recipe where the @@ -2532,7 +2533,7 @@ doing the following: .. note:: - If image prelinking is enabled (e.g. "image-prelink" is in :term:`USER_CLASSES` + If image prelinking is enabled (e.g. :ref:`image-prelink ` is in :term:`USER_CLASSES` which it is by default), prelink will change the binaries in the generated images and this often catches people out. Remove that class to ensure binaries are preserved exactly if that is necessary. @@ -4454,19 +4455,16 @@ Follow these steps to build your target using the files in the downloads directory: 1. *Using Local Files Only:* Inside your ``local.conf`` file, add the - :term:`SOURCE_MIRROR_URL` - variable, inherit the - :ref:`own-mirrors ` - class, and use the - :term:`BB_NO_NETWORK` - variable to your ``local.conf``. + :term:`SOURCE_MIRROR_URL` variable, inherit the + :ref:`own-mirrors ` class, and use the + :term:`BB_NO_NETWORK` variable to your ``local.conf``. :: SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" INHERIT += "own-mirrors" BB_NO_NETWORK = "1" - The :term:`SOURCE_MIRROR_URL` and ``own-mirror`` + The :term:`SOURCE_MIRROR_URL` and :ref:`own-mirrors ` class set up the system to use the downloads directory as your "own mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that BitBake's fetching process in step 3 stays local, which means files @@ -4748,7 +4746,8 @@ done using the Eventually, all recipes will be covered and this list will not be needed. -For the most part, the Multilib class extension works automatically to +For the most part, the :ref:`Multilib ` +class extension works automatically to extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where :term:`MLPREFIX` is the particular multilib (e.g. "lib32-" or "lib64-"). Standard variables such as @@ -4760,8 +4759,7 @@ Standard variables such as :term:`PACKAGES_DYNAMIC` are automatically extended by the system. If you are extending any manual code in the recipe, you can use the ``${MLPREFIX}`` variable to ensure -those names are extended correctly. This automatic extension code -resides in ``multilib.bbclass``. +those names are extended correctly. Using Multilib ~~~~~~~~~~~~~~ @@ -10967,7 +10965,7 @@ accidental release of proprietary software. The Yocto Project provides an :ref:`archiver ` class to help avoid some of these concerns. -Before you employ :term:`DL_DIR` or the ``archiver`` class, you need to +Before you employ :term:`DL_DIR` or the :ref:`archiver ` class, you need to decide how you choose to provide source. The source ``archiver`` class can generate tarballs and SRPMs and can create them with various levels of compliance in mind. diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 89a5eb49fb..33b4071026 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1800,7 +1800,7 @@ type of output occurs when a set of data is merged into a shared directory tree such as the sysroot. The Yocto Project team has tried to keep the details of the -implementation hidden in ``sstate`` class. From a user's perspective, +implementation hidden in the :ref:`sstate ` class. From a user's perspective, adding shared state wrapping to a task is as simple as this :ref:`ref-tasks-deploy` example taken from the :ref:`deploy ` class:: diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 101d283665..4a3a97e29a 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -121,7 +121,7 @@ the following types of tests: $ bitbake image -c testsdkext - The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. + The tests utilize the :ref:`testsdkext ` class and the ``do_testsdkext`` task. - *Feature Testing:* Various scenario-based tests are run through the :ref:`OpenEmbedded Self test (oe-selftest) `. We test oe-selftest on each of the main distributions