manuals: add missing references to classes
PATCH 1/3 manuals: add missing references to classes
From: Michael Opdenacker <[email protected]>
Sometimes fixing line length in modified paragraphs too.
[YOCTO #14508]
Reported-by Quentin Schulz <[email protected]>
Signed-off-by Michael Opdenacker <[email protected]>
--- documentation/dev-manual/common-tasks.rst | 30 +++-- .../migration-guides/migration-1.3.rst | 21 ++- .../migration-guides/migration-1.5.rst | 5 + .../migration-guides/migration-1.6.rst | 9 +- .../migration-guides/migration-1.8.rst | 6 +- .../migration-guides/migration-2.1.rst | 8 +- .../migration-guides/migration-2.3.rst | 21 ++- .../migration-guides/migration-2.6.rst | 12 +- .../migration-guides/migration-3.0.rst | 4 +- .../migration-guides/migration-3.2.rst | 8 +- .../migration-guides/migration-3.3.rst | 16 ++- .../migration-guides/migration-3.4.rst | 2 +- .../migration-guides/migration-general.rst | 21 +-- .../migration-guides/release-notes-3.4.rst | 6 +- .../migration-guides/release-notes-4.0.rst | 15 ++- .../migration-guides/release-notes-4.1.rst | 9 +- documentation/overview-manual/concepts.rst | 2 +- documentation/ref-manual/classes.rst | 13 +- documentation/ref-manual/structure.rst | 3 +- documentation/ref-manual/variables.rst | 125 +++++++++--------- .../test-manual/understand-autobuilder.rst | 2 +- 21 files changed, 182 insertions(+), 156 deletions(-)
documentation/dev-manual/common-tasks.rst +16 -14
@@ -1855,9 +1855,10 @@ Here are some common issues that cause failures. ":ref:`dev-manual/common-tasks:debugging parallel make races`" section. - *Improper host path usage:* This failure applies to recipes building - for the target or ``nativesdk`` only. The failure occurs when the - compilation process uses improper headers, libraries, or other files - from the host system when cross-compiling for the target. + for the target or ":ref:`nativesdk <ref-classes-nativesdk>`" only. The + failure occurs when the compilation process uses improper headers, + libraries, or other files from the host system when cross-compiling for + the target. To fix the problem, examine the ``log.do_compile`` file to identify the host paths being used (e.g. ``/usr/include``, ``/usr/lib``, and
@@ -3404,7 +3405,7 @@ form of a patch all using Quilt. .. note:: With regard to preserving changes to source files, if you clean a - recipe or have ``rm_work`` enabled, the + recipe or have :ref:`rm_work <ref-classes-rm-work>` enabled, the :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` as described in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual is a safer
@@ -3450,11 +3451,11 @@ Follow these general steps: .. note:: All the modifications you make to the temporary source code disappear - once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` tasks using BitBake - (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). - Modifications will also disappear if you use the ``rm_work`` feature as - described in the - ":ref:`dev-manual/common-tasks:conserving disk space during builds`" + once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` + tasks using BitBake (i.e. ``bitbake -c clean package`` and + ``bitbake -c cleanall package``). Modifications will also disappear if + you use the :ref:`rm_work <ref-classes-rm-work>` feature as described in + the ":ref:`dev-manual/common-tasks:conserving disk space during builds`" section. 7. *Generate the Patch:* Once your changes work as expected, you need to
@@ -7143,7 +7144,8 @@ Lighttpd, or Nginx), take the appropriate steps to do so. From within the :term:`Build Directory` where you have built an image based on your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start the server. The following example assumes a :term:`Build Directory` of ``poky/build`` -and a :term:`PACKAGE_CLASSES` setting of "package_rpm":: +and a :term:`PACKAGE_CLASSES` setting of +":ref:`package_rpm <ref-classes-package_rpm>`":: $ cd poky/build/tmp/deploy/rpm $ python3 -m http.server
@@ -7491,8 +7493,8 @@ test. Here is what you have to do for each recipe: special configurations prior to compiling the test code, you must insert a ``do_configure_ptest`` function into the recipe. -- *Install the test suite:* The ``ptest`` class automatically copies - the file ``run-ptest`` to the target and then runs make +- *Install the test suite:* The :ref:`ptest <ref-classes-ptest>` class + automatically copies the file ``run-ptest`` to the target and then runs make ``install-ptest`` to run the tests. If this is not enough, you need to create a ``do_install_ptest`` function and make sure it gets called after the "make install-ptest" completes.
@@ -11237,7 +11239,7 @@ an :ref:`archiver <ref-classes-archiver>` class to help avoid some of these concerns. Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to -decide how you choose to provide source. The source ``archiver`` class +decide how you choose to provide source. The source :ref:`archiver <ref-classes-archiver>` class can generate tarballs and SRPMs and can create them with various levels of compliance in mind.
@@ -11325,7 +11327,7 @@ generation are included on your image. adds a separate package and an upgrade path for adding licenses to an image. -As the source ``archiver`` class has already archived the original +As the source :ref:`archiver <ref-classes-archiver>` class has already archived the original unmodified source that contains the license files, you would have already met the requirements for inclusion of the license information with source as defined by the GPL and other open source licenses.
documentation/migration-guides/migration-1.3.rst +10 -11
@@ -91,11 +91,11 @@ consistency. nativesdk ~~~~~~~~~ -The suffix ``nativesdk`` is now implemented as a prefix, which -simplifies a lot of the packaging code for ``nativesdk`` recipes. All -custom ``nativesdk`` recipes, which are relocatable packages that are -native to :term:`SDK_ARCH`, and any references need to -be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. +The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a +lot of the packaging code for :ref:`nativesdk <ref-classes-nativesdk>` recipes. +All custom :ref:`nativesdk <ref-classes-nativesdk>` recipes, which are +relocatable packages that are native to :term:`SDK_ARCH`, and any references +need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. .. _migration-1.3-task-recipes:
@@ -109,12 +109,11 @@ automatic upgrade path for most packages. However, you should update references in your own recipes and configurations as they could be removed in future releases. You should also rename any custom ``task-*`` recipes to ``packagegroup-*``, and change them to inherit -``packagegroup`` instead of ``task``, as well as taking the opportunity -to remove anything now handled by :ref:`ref-classes-packagegroup`, such as -providing ``-dev`` and ``-dbg`` packages, setting -:term:`LIC_FILES_CHKSUM`, and so forth. See the -:ref:`ref-classes-packagegroup` section for -further details. +:ref:`packagegroup <ref-classes-packagegroup>` instead of ``task``, as well +as taking the opportunity to remove anything now handled by +:ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` +packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the +:ref:`ref-classes-packagegroup` section for further details. .. _migration-1.3-image-features:
documentation/migration-guides/migration-1.5.rst +5 -0
@@ -130,6 +130,11 @@ The following directory changes exist: it easier to delete :term:`TMPDIR` and preserve the build history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. +- When :ref:`buildhistory <ref-classes-buildhistory>` is enabled, its output + is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. + Doing so makes it easier to delete :term:`TMPDIR` and preserve the build + history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. + - The ``pkgdata`` directory produced as part of the packaging process has been collapsed into a single machine-specific directory. This directory is located under ``sysroots`` and uses a machine-specific
documentation/migration-guides/migration-1.6.rst +5 -4
@@ -220,9 +220,10 @@ Package Test (ptest) Package Tests (ptest) are built but not installed by default. For information on using Package Tests, see the -":ref:`dev-manual/common-tasks:testing packages with ptest`" -section in the Yocto Project Development Tasks Manual. For information on the -``ptest`` class, see the ":ref:`ref-classes-ptest`" section. +":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the +Yocto Project Development Tasks Manual. For information on the +:ref:`ptest <ref-classes-ptest>` class, see the ":ref:`ref-classes-ptest`" +section. .. _migration-1.6-build-changes:
@@ -237,7 +238,7 @@ will enable a separate :term:`Build Directory` by default as well. Recipes building Autotools-based software that fails to build with a separate :term:`Build Directory` should be changed to inherit from the :ref:`autotools-brokensep <ref-classes-autotools>` class instead of -the ``autotools`` or ``autotools_stage``\ classes. +the :ref:`autotools <ref-classes-autotools>` or ``autotools_stage`` classes. .. _migration-1.6-building-qemu-native:
documentation/migration-guides/migration-1.8.rst +3 -3
@@ -76,15 +76,15 @@ particular, users need to ensure that ``${S}`` (source files) and ``${B}`` (build artifacts) are used correctly in functions such as :ref:`ref-tasks-configure` and :ref:`ref-tasks-install`. For kernel recipes that do not -inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might +inherit from :ref:`kernel-yocto <ref-classes-kernel-yocto>` or include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, here is the :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` where the ``linux.inc`` file in ``meta-oe`` was updated. Recipes that rely on the kernel source code and do not inherit the -module classes might need to add explicit dependencies on the -:ref:`ref-tasks-shared_workdir` kernel task, for example:: +:ref:`module <ref-classes-module>` classes might need to add explicit +dependencies on the :ref:`ref-tasks-shared_workdir` kernel task, for example:: do_configure[depends] += "virtual/kernel:do_shared_workdir"
documentation/migration-guides/migration-2.1.rst +4 -4
@@ -64,7 +64,7 @@ Makefile Environment Changes :term:`EXTRA_OEMAKE` now defaults to "" instead of "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default was a historical accident that has required many classes (e.g. -``autotools``, ``module``) and recipes to override this default in order +:ref:`autotools <ref-classes-autotools>`, ``module``) and recipes to override this default in order to work with sensible build systems. When upgrading to the release, you must edit any recipe that relies upon this old default by either setting :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any
@@ -191,7 +191,7 @@ The following classes have changed: - ``autotools_stage``: Removed because the :ref:`autotools <ref-classes-autotools>` class now provides its functionality. Recipes that inherited from ``autotools_stage`` should - now inherit from ``autotools`` instead. + now inherit from :ref:`autotools <ref-classes-autotools>` instead. - ``boot-directdisk``: Merged into the ``image-vm`` class. The ``boot-directdisk`` class was rarely directly used. Consequently,
@@ -401,9 +401,9 @@ These additional changes exist: as these directories are automatically found and added. - Inaccurate disk and CPU percentage data has been dropped from - ``buildstats`` output. This data has been replaced with + :ref:`buildstats <ref-classes-buildstats>` output. This data has been replaced with ``getrusage()`` data and corrected IO statistics. You will probably - need to update any custom code that reads the ``buildstats`` data. + need to update any custom code that reads the :ref:`buildstats <ref-classes-buildstats>` data. - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. The contents of this file have been moved to individual recipes.
documentation/migration-guides/migration-2.3.rst +10 -11
@@ -481,9 +481,9 @@ The following miscellaneous changes have occurred: is an unnecessary burden. If you need to preserve these ``.la`` files (e.g. in a custom - distribution), you must change - :term:`INHERIT_DISTRO` such that - "remove-libtool" is not included in the value. + distribution), you must change :term:`INHERIT_DISTRO` such that + ":ref:`remove-libtool <ref-classes-remove-libtool>`" is not included + in the value. - Extensible SDKs built for GCC 5+ now refuse to install on a distribution where the host GCC version is 4.8 or 4.9. This change
@@ -492,18 +492,17 @@ The following miscellaneous changes have occurred: the :ref:`uninative <ref-classes-uninative>` class for additional information. -- All native and nativesdk recipes now use a separate +- All :ref:`native <ref-classes-native>` and + :ref:`nativesdk <ref-classes-nativesdk>` recipes now use a separate :term:`DISTRO_FEATURES` value instead of sharing the value used by recipes for the target, in order to avoid unnecessary rebuilds. - The :term:`DISTRO_FEATURES` for ``native`` recipes is - :term:`DISTRO_FEATURES_NATIVE` added to - an intersection of :term:`DISTRO_FEATURES` and - :term:`DISTRO_FEATURES_FILTER_NATIVE`. + The :term:`DISTRO_FEATURES` for :ref:`native <ref-classes-native>` recipes + is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of + :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. - For nativesdk recipes, the corresponding variables are - :term:`DISTRO_FEATURES_NATIVESDK` - and + For :ref:`nativesdk <ref-classes-nativesdk>` recipes, the corresponding + variables are :term:`DISTRO_FEATURES_NATIVESDK` and :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. - The ``FILESDIR`` variable, which was previously deprecated and rarely
documentation/migration-guides/migration-2.6.rst +6 -6
@@ -128,7 +128,8 @@ missing from :term:`DEPENDS`). This change affects classes beyond just the two mentioned (i.e. ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` - classes are affected. For example, the ``setuptools`` and ``setuptools3`` + classes are affected. For example, the ``setuptools`` and + :ref:`setuptools3 <ref-classes-setuptools3>` recipes are affected since they inherit the ``distutils*`` classes. Fetching these types of dependencies that are not provided in the
@@ -315,13 +316,12 @@ This section provides information about automatic testing changes: exists and has been replaced by the :term:`TESTIMAGE_AUTO` variable. -- Inheriting the ``testimage`` and ``testsdk`` Classes: Best - practices now dictate that you use the - :term:`IMAGE_CLASSES` variable rather than the +- Inheriting the :ref:`testimage <ref-classes-testimage>` and + :ref:`testsdk <ref-classes-testsdk>` classes: best practices now dictate + that you use the :term:`IMAGE_CLASSES` variable rather than the :term:`INHERIT` variable when you inherit the :ref:`testimage <ref-classes-testimage>` and - :ref:`testsdk <ref-classes-testsdk>` classes used for automatic - testing. + :ref:`testsdk <ref-classes-testsdk>` classes used for automatic testing. .. _migration-2.6-openssl-changes:
documentation/migration-guides/migration-3.0.rst +2 -2
@@ -282,8 +282,8 @@ The following miscellaneous changes have occurred. - You must change the host distro identifier used in :term:`NATIVELSBSTRING` to use all lowercase characters even if it does not contain a version number. This change - is necessary only if you are not using ``uninative`` and - :term:`SANITY_TESTED_DISTROS`. + is necessary only if you are not using + :ref:`uninative <ref-classes-uninative>` and :term:`SANITY_TESTED_DISTROS`. - In the ``base-files`` recipe, writing the hostname into ``/etc/hosts`` and ``/etc/hostname`` is now done within the main
documentation/migration-guides/migration-3.2.rst +7 -1
@@ -217,7 +217,13 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` ------------------------------------------------------------------------------- -All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`. +All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due +to their postinstall scriptlets, thus this package has to be dummy-provided +within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have +a custom SDK recipe (or your own SDK-style recipe similar to e.g. +``buildtools-tarball``), you will need to ensure +``nativesdk-sdk-provides-dummy`` or an equivalent is included in +:term:`TOOLCHAIN_HOST_TASK`. ``ld.so.conf`` now moved back to main ``glibc`` package
documentation/migration-guides/migration-3.3.rst +9 -7
@@ -61,13 +61,15 @@ need to update those. New ``python3targetconfig`` class --------------------------------- -A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been -created for situations where you would previously have inherited the -:ref:`python3native <ref-classes-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 -appropriate in order to avoid unnecessarily lengthening builds. +A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has +been created for situations where you would previously have inherited the +:ref:`python3native <ref-classes-python3native>` class but need access to +target configuration data (such as correct installation directories). Recipes +where this situation applies should be changed to inherit +:ref:`python3targetconfig <ref-classes-python3targetconfig>` instead of +:ref:`python3native <ref-classes-python3native>`. This also adds a dependency +on target ``python3``, so it should only be used where appropriate in order to +avoid unnecessarily lengthening builds. Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, ``python3-pycairo``.
documentation/migration-guides/migration-3.4.rst +1 -1
@@ -124,7 +124,7 @@ Removed classes - ``image-mklibs``: not actively tested and upstream mklibs still requires Python 2 - ``meta``: no longer useful. Recipes that need to skip installing - packages should inherit ``nopackages`` instead. + packages should inherit :ref:`nopackages <ref-classes-nopackages>` instead. Prelinking disabled by default ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
documentation/migration-guides/migration-general.rst +11 -10
@@ -79,18 +79,19 @@ any new Yocto Project release. the migration (e.g. added/removed packages, added/removed files, size changes etc.). To do this, follow these steps: - 1. Enable buildhistory before the migration + 1. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration 2. Run a pre-migration build - 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`) - and ensure it is preserved for subsequent builds. How you would do this - depends on how you are running your builds - if you are doing this all on - one workstation in the same :term:`Build Directory` you may not need to do - anything other than not deleting the buildhistory output directory. For - builds in a pipeline it may be more complicated. + 3. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as + specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for + subsequent builds. How you would do this depends on how you are running + your builds - if you are doing this all on one workstation in the same + :term:`Build Directory` you may not need to do anything other than not + deleting the :ref:`buildhistory <ref-classes-buildhistory>` output + directory. For builds in a pipeline it may be more complicated. - 4. Set a tag in the buildhistory output (which is a git repository) before + 4. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before migration, to make the commit from the pre-migration build easy to find as you may end up running multiple builds during the migration.
@@ -99,7 +100,7 @@ any new Yocto Project release. 6. Run a build 7. Check the output changes between the previously set tag and HEAD in the - buildhistory output using ``git diff`` or ``buildhistory-diff``. + :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. - For more information on using buildhistory, see + For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see :ref:`dev-manual/common-tasks:maintaining build output quality`.
documentation/migration-guides/release-notes-3.4.rst +4 -2
@@ -7,7 +7,7 @@ New Features / Enhancements in 3.4 - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help - Rust integrated into core, providing rust support for cross-compilation and SDK -- New create-spdx class for creating SPDX SBoM documents +- New :ref:`create-spdx <ref-classes-create-spdx>` class for creating SPDX SBoM documents - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland - Several optimisations to reduce unnecessary task dependencies for faster builds - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu
@@ -68,7 +68,9 @@ New Features / Enhancements in 3.4 - SDK-related enhancements: - Enable :ref:`ref-tasks-populate_sdk` with multilibs - - New ``SDKPATHINSTALL`` variable decouples default install path from built in path to avoid rebuilding nativesdk components on e.g. :term:`DISTRO_VERSION` changes + - New ``SDKPATHINSTALL`` variable decouples default install path from + built in path to avoid rebuilding :ref:`nativesdk <ref-classes-nativesdk>` + components on e.g. :term:`DISTRO_VERSION` changes - eSDK: Error if trying to generate an eSDK from a multiconfig - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK
documentation/migration-guides/release-notes-4.0.rst +9 -6
@@ -8,9 +8,10 @@ New Features / Enhancements in 4.0 - Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades -- Reproducibility: this release fixes the reproducibility issues with ``rust-llvm`` and - ``golang``. Recipes in OpenEmbedded-Core are now fully reproducible. Functionality - previously in the optional "reproducible" class has been merged into the base class. +- Reproducibility: this release fixes the reproducibility issues with + ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully + reproducible. Functionality previously in the optional "reproducible" + class has been merged into the :ref:`base <ref-classes-base>` class. - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it)
@@ -215,7 +216,7 @@ New Features / Enhancements in 4.0 - Ensure addition of patch-fuzz retriggers do_qa_patch - Added a sanity check for allarch packagegroups -- create-spdx class improvements: +- :ref:`create-spdx <ref-classes-create-spdx>` class improvements: - Get SPDX-License-Identifier from source files - Generate manifest also for SDKs
@@ -235,8 +236,10 @@ New Features / Enhancements in 4.0 - SDK-related enhancements: - - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` - - Enabled nativesdk recipes to find a correct version of the rust cross compiler + - Extended recipes to :ref:`nativesdk <ref-classes-nativesdk>`: ``cargo``, + ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` + - Enabled :ref:`nativesdk <ref-classes-nativesdk>` recipes to find a correct version + of the rust cross compiler - Support creating per-toolchain cmake file in SDK - Rust enhancements:
documentation/migration-guides/release-notes-4.1.rst +5 -4
@@ -58,7 +58,7 @@ New Features / Enhancements in 4.1 - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable - Support for CPU, I/O and memory pressure regulation in BitBake -- Pressure data gathering in ``buildstats`` and rendering in ``pybootchartgui`` +- Pressure data gathering in :ref:`buildstats <ref-classes-buildstats>` and rendering in ``pybootchartgui`` - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class
@@ -99,8 +99,8 @@ New Features / Enhancements in 4.1 - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK - - rust-llvm: enabled nativesdk variant - - python3-pluggy: enabled for native/nativesdk + - rust-llvm: enabled :ref:`nativesdk <ref-classes-nativesdk>` variant + - python3-pluggy: enabled for :ref:`native <ref-classes-native>` / :ref:`nativesdk <ref-classes-nativesdk>` - QEMU/runqemu enhancements:
@@ -113,7 +113,8 @@ New Features / Enhancements in 4.1 - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel - - image_types: isolate the write of UBI configuration to a ``write_ubi_config`` function that can be easily overridden + - :ref:`image_types <ref-classes-image_types>`: isolate the write of UBI + configuration to a ``write_ubi_config`` function that can be easily overridden - openssh: add support for config snippet includes to ssh and sshd - :ref:`create-spdx <ref-classes-create-spdx>`: Add ``SPDX_PRETTY`` option
documentation/overview-manual/concepts.rst +1 -1
@@ -921,7 +921,7 @@ the analysis and package splitting process use several areas: - :term:`STAGING_DIR_TARGET`: The path for the sysroot used when a component that is built to execute on a system and it generates code for yet another machine - (e.g. cross-canadian recipes). + (e.g. :ref:`cross-canadian <ref-classes-cross-canadian>` recipes). The :term:`FILES` variable defines the files that go into each package in
documentation/ref-manual/classes.rst +7 -6
@@ -1406,7 +1406,7 @@ an optional Initramfs bundle, an optional RAM disk, and any number of device tree. To create a FIT image, it is required that :term:`KERNEL_CLASSES` -is set to include "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` +is set to include ":ref:`kernel-fitimage <ref-classes-kernel-fitimage>`" and :term:`KERNEL_IMAGETYPE` is set to "fitImage". The options for the device tree compiler passed to ``mkimage -D``
@@ -2566,11 +2566,12 @@ uses these build systems, the recipe needs to inherit the :ref:`setuptools3 <ref ``setuptools3_legacy.bbclass`` ============================== -The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports Python version 3.x extensions that use -build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and have -not migrated to the official ``pyproject.toml`` format). Unlike -``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and -``install`` commands and not wheels. This use of ``setuptools`` like this is +The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports +Python version 3.x extensions that use build systems based on ``setuptools`` +(e.g. only have a ``setup.py`` and have not migrated to the official +``pyproject.toml`` format). Unlike :ref:`setuptools3 <ref-classes-setuptools3>`, +this uses the traditional ``setup.py`` ``build`` and ``install`` commands and +not wheels. This use of ``setuptools`` like this is `deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__ but still relatively common.
documentation/ref-manual/structure.rst +2 -1
@@ -374,7 +374,8 @@ remove the ``build/sstate-cache`` directory. ``build/tmp/buildstats/`` ~~~~~~~~~~~~~~~~~~~~~~~~~ -This directory stores the build statistics. +This directory stores the build statistics as generated by the +:ref:`buildstats <ref-classes-buildstats>` class. .. _structure-build-tmp-cache:
documentation/ref-manual/variables.rst +64 -61
264 lines not on this page · raw message
documentation/test-manual/understand-autobuilder.rst +1 -1
@@ -206,7 +206,7 @@ are general setup steps that are run once and include: #. Set up any ``buildtools-tarball`` if configured. -#. Call "buildhistory-init" if buildhistory is configured. +#. Call "buildhistory-init" if :ref:`buildhistory <ref-classes-buildhistory>` is configured. For each step that is configured in ``config.json``, it will perform the following:
Signature · 1 line
2.34.1
PATCH 2/3 manuals: fix paragraphs with the "inherit" word
From: Michael Opdenacker <[email protected]>
Nothing wrong with this word, but instances of "inherit" were looked for while looking for class names without references. Fixing alignment and sometimes syntax.
Signed-off-by Michael Opdenacker <[email protected]>
--- documentation/dev-manual/common-tasks.rst | 60 +++++++------------ .../migration-guides/migration-1.5.rst | 4 +- .../migration-guides/migration-3.0.rst | 4 +- .../migration-guides/migration-3.3.rst | 6 +- documentation/ref-manual/classes.rst | 14 ++--- documentation/ref-manual/qa-checks.rst | 20 ++++--- documentation/ref-manual/variables.rst | 23 ++++--- .../sdk-manual/appendix-customizing.rst | 15 +++-- 8 files changed, 64 insertions(+), 82 deletions(-)
documentation/dev-manual/common-tasks.rst +22 -38
@@ -1703,26 +1703,21 @@ your software is built: need to modify the configuration. When using Autotools, your recipe needs to inherit the - :ref:`autotools <ref-classes-autotools>` class - and your recipe does not have to contain a - :ref:`ref-tasks-configure` task. - However, you might still want to make some adjustments. For example, - you can set - :term:`EXTRA_OECONF` or - :term:`PACKAGECONFIG_CONFARGS` - to pass any needed configure options that are specific to the recipe. + :ref:`autotools <ref-classes-autotools>` class and it does not have to + contain a :ref:`ref-tasks-configure` task. However, you might still want to + make some adjustments. For example, you can set :term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS` to pass any needed configure options that + are specific to the recipe. - *CMake:* If your source files have a ``CMakeLists.txt`` file, then your software is built using CMake. If this is the case, you just need to modify the configuration. When you use CMake, your recipe needs to inherit the - :ref:`cmake <ref-classes-cmake>` class and your - recipe does not have to contain a - :ref:`ref-tasks-configure` task. - You can make some adjustments by setting - :term:`EXTRA_OECMAKE` to - pass any needed configure options that are specific to the recipe. + :ref:`cmake <ref-classes-cmake>` class and it does not have to contain a + :ref:`ref-tasks-configure` task. You can make some adjustments by setting + :term:`EXTRA_OECMAKE` to pass any needed configure options that are + specific to the recipe. .. note::
@@ -1997,9 +1992,8 @@ different ways: shutdown of all other programs. To enable a service using SysVinit, your recipe needs to inherit the - :ref:`update-rc.d <ref-classes-update-rc.d>` - class. The class helps facilitate safely installing the package on - the target. + :ref:`update-rc.d <ref-classes-update-rc.d>` class. The class helps + facilitate safely installing the package on the target. You will need to set the :term:`INITSCRIPT_PACKAGES`,
@@ -2014,10 +2008,8 @@ different ways: https://freedesktop.org/wiki/Software/systemd/. To enable a service using systemd, your recipe needs to inherit the - :ref:`systemd <ref-classes-systemd>` class. See - the ``systemd.bbclass`` file located in your :term:`Source Directory` - section for - more information. + :ref:`systemd <ref-classes-systemd>` class. See the ``systemd.bbclass`` file + located in your :term:`Source Directory` section for more information. Packaging ---------
@@ -2370,8 +2362,7 @@ Autotooled Package Applications that use Autotools such as ``autoconf`` and ``automake`` require a recipe that has a source archive listed in :term:`SRC_URI` and -also inherit the -:ref:`autotools <ref-classes-autotools>` class, +also inherit the :ref:`autotools <ref-classes-autotools>` class, which contains the definitions of all the steps needed to build an Autotool-based application. The result of the build is automatically packaged. And, if the application uses NLS for localization, packages
@@ -4404,13 +4395,10 @@ where the development occurs. You want the recipe's :term:`SRC_URI` variable to point to the external directory and use it as is, not copy it. -To build from software that comes from an external source, all you need -to do is inherit the -:ref:`externalsrc <ref-classes-externalsrc>` class -and then set the -:term:`EXTERNALSRC` variable to -point to your external source code. Here are the statements to put in -your ``local.conf`` file:: +To build from software that comes from an external source, all you need to do +is inherit the :ref:`externalsrc <ref-classes-externalsrc>` class and then set +the :term:`EXTERNALSRC` variable to point to your external source code. Here +are the statements to put in your ``local.conf`` file:: INHERIT += "externalsrc" EXTERNALSRC:pn-myrecipe = "path-to-your-source-tree"
@@ -4494,8 +4482,7 @@ directory: 1. *Using Local Files Only:* Inside your ``local.conf`` file, add the :term:`SOURCE_MIRROR_URL` variable, inherit the :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the - :term:`BB_NO_NETWORK` variable to your ``local.conf``. - :: + :term:`BB_NO_NETWORK` variable to your ``local.conf``:: SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" INHERIT += "own-mirrors"
@@ -7441,8 +7428,7 @@ In order to enable a recipe to run installed ptests on target hardware, you need to prepare the recipes that build the packages you want to test. Here is what you have to do for each recipe: -- *Be sure the recipe inherits - the* :ref:`ptest <ref-classes-ptest>` *class:* +- *Be sure the recipe inherits the* :ref:`ptest <ref-classes-ptest>` *class:* Include the following line in each recipe:: inherit ptest
@@ -8868,8 +8854,7 @@ You can start the tests automatically or manually: bitbake core-image-sato - *Manually running tests:* To manually run the tests, first globally - inherit the - :ref:`testimage <ref-classes-testimage>` class + inherit the :ref:`testimage <ref-classes-testimage>` class by editing your ``local.conf`` file:: INHERIT += "testimage"
@@ -9287,8 +9272,7 @@ In addition to variable values, the output of the ``bitbake -e`` and classes included globally, recursively listing the files they include or inherit in turn. Much of the behavior of the OpenEmbedded build system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is - implemented in the - :ref:`base <ref-classes-base>` class and the + implemented in the :ref:`base <ref-classes-base>` class and the classes it inherits, rather than being built into BitBake itself. - After the variable values, all functions appear in the output. For
documentation/migration-guides/migration-1.5.rst +2 -2
@@ -221,8 +221,8 @@ Task Recipes The previously deprecated ``task.bbclass`` has now been dropped. For recipes that previously inherited from this class, you should rename -them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup -instead. +them from ``task-*`` to ``packagegroup-*`` and inherit +:ref:`packagegroup <ref-classes-packagegroup>` instead. For more information, see the ":ref:`ref-classes-packagegroup`" section.
documentation/migration-guides/migration-3.0.rst +3 -1
@@ -259,7 +259,9 @@ The following miscellaneous changes have occurred. - The ``gnome`` class has been removed because it now does very little. You should update recipes that previously inherited this class to do - the following: inherit gnomebase gtk-icon-cache gconf mime + the following:: + + inherit gnomebase gtk-icon-cache gconf mime - The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been removed. This file was previously deprecated in favor of setting
documentation/migration-guides/migration-3.3.rst +3 -3
@@ -99,9 +99,9 @@ variable so that recipes can specify it explicitly, for example:: Recipes that inherit from ``distutils3`` (or :ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits -``distutils3``) that also set :term:`S` to -point to a Python module within a subdirectory in the aforementioned -manner should be changed to set ``DISTUTILS_SETUP_PATH`` instead. +``distutils3``) that also set :term:`S` to point to a Python module within a +subdirectory in the aforementioned manner should be changed to set +``DISTUTILS_SETUP_PATH`` instead. .. _migration-3.3-bitbake:
documentation/ref-manual/classes.rst +6 -8
@@ -210,9 +210,8 @@ information. An alternative version of the :ref:`binconfig <ref-classes-binconfig>` class, which disables binary configuration scripts by making them return an error in favor of using ``pkg-config`` to query the information. The -scripts to be disabled should be specified using the -:term:`BINCONFIG` variable within the recipe inheriting -the class. +scripts to be disabled should be specified using the :term:`BINCONFIG` +variable within the recipe inheriting the class. .. _ref-classes-buildhistory:
@@ -580,8 +579,7 @@ By default, the OpenEmbedded build system uses the :term:`S` and :term:`B` variables to locate unpacked recipe source code and to build it, respectively. When your recipe inherits the :ref:`externalsrc <ref-classes-externalsrc>` class, you use the -:term:`EXTERNALSRC` and -:term:`EXTERNALSRC_BUILD` variables to +:term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD` variables to ultimately define :term:`S` and :term:`B`. By default, this class expects the source code to support recipe builds
@@ -734,9 +732,9 @@ register and unregister the schemas in the target image. ``gettext.bbclass`` =================== -The :ref:`gettext <ref-classes-gettext>` class provides support for building software that uses -the GNU ``gettext`` internationalization and localization system. All -recipes building software that use ``gettext`` should inherit this +The :ref:`gettext <ref-classes-gettext>` class provides support for building +software that uses the GNU ``gettext`` internationalization and localization +system. All recipes building software that use ``gettext`` should inherit this class. .. _ref-classes-github-releases:
documentation/ref-manual/qa-checks.rst +11 -9
@@ -579,10 +579,10 @@ Errors and Warnings - ``package contains mime types but does not inherit mime: <packagename> path '<file>' [mime]`` The specified package contains mime type files (``.xml`` files in - ``${datadir}/mime/packages``) and yet does not inherit the mime - class which will ensure that these get properly installed. Either - add ``inherit mime`` to the recipe or remove the files at the - :ref:`ref-tasks-install` step if they are not needed. + ``${datadir}/mime/packages``) and yet does not inherit the + :ref:`mime <ref-classes-mime>` class which will ensure that these get + properly installed. Either add ``inherit mime`` to the recipe or remove the + files at the :ref:`ref-tasks-install` step if they are not needed. .. _qa-check-mime-xdg:
@@ -620,11 +620,13 @@ Errors and Warnings - ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` - This check ensures that if one of the variables that the :ref:`features_check <ref-classes-features_check>` - class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe - inherits ``features_check`` in order for the requirement to actually work. If - you are seeing this message, either add ``inherit features_check`` to your recipe - or remove the reference to the variable if it is not needed. + This check ensures that if one of the variables that the + :ref:`features_check <ref-classes-features_check>` class supports (e.g. + :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe + inherits :ref:`features_check <ref-classes-features_check>` in order for + the requirement to actually work. If you are seeing this message, either + add ``inherit features_check`` to your recipe or remove the reference to + the variable if it is not needed. .. _qa-check-missing-update-alternatives:
documentation/ref-manual/variables.rst +10 -13
@@ -126,8 +126,7 @@ system and gives an overview of their function and contents. ":ref:`ref-classes-update-alternatives`" section. :term:`ANY_OF_DISTRO_FEATURES` - When inheriting the - :ref:`features_check <ref-classes-features_check>` + When inheriting the :ref:`features_check <ref-classes-features_check>` class, this variable identifies a list of distribution features where at least one must be enabled in the current configuration in order for the OpenEmbedded build system to build the recipe. In other words,
@@ -215,12 +214,11 @@ system and gives an overview of their function and contents. If you use the previous statement to retrieve the latest version of software, you need to be sure :term:`PV` contains - ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you - have a kernel recipe that inherits the - :ref:`kernel <ref-classes-kernel>` class and you use the previous - statement. In this example, ``${SRCPV}`` does not automatically get - into :term:`PV`. Consequently, you need to change :term:`PV` in your recipe - so that it does contain ``${SRCPV}``. + ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you have a kernel + recipe that inherits the :ref:`kernel <ref-classes-kernel>` class and you + use the previous statement. In this example, ``${SRCPV}`` does not + automatically get into :term:`PV`. Consequently, you need to change + :term:`PV` in your recipe so that it does contain ``${SRCPV}``. For more information see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
@@ -3566,9 +3564,9 @@ system and gives an overview of their function and contents. IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" - Recipes inheriting the ``image`` class should copy files to be - deployed into :term:`IMGDEPLOYDIR`, and the class will take care of - copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. + Recipes inheriting the :ref:`image <ref-classes-image>` class should copy + files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take + care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. :term:`INC_PR` Helps define the recipe revision for recipes that share a common
@@ -6542,8 +6540,7 @@ system and gives an overview of their function and contents. section. :term:`REQUIRED_DISTRO_FEATURES` - When inheriting the - :ref:`features_check <ref-classes-features_check>` + When inheriting the :ref:`features_check <ref-classes-features_check>` class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe. In other words, if the
documentation/sdk-manual/appendix-customizing.rst +7 -8
@@ -44,14 +44,13 @@ build system applies them against ``local.conf`` and ``auto.conf``: :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two filters. The default value is blank. -- Classes inherited globally with - :term:`INHERIT` that are listed in - :term:`ESDK_CLASS_INHERIT_DISABLE` - are disabled. Using :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these - classes is the typical method to disable classes that are problematic - or unnecessary in the SDK context. The default value disables the - :ref:`buildhistory <ref-classes-buildhistory>` - and :ref:`icecc <ref-classes-icecc>` classes. +- Classes inherited globally with :term:`INHERIT` that are listed in + :term:`ESDK_CLASS_INHERIT_DISABLE` are disabled. Using + :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these classes is the typical + method to disable classes that are problematic or unnecessary in the SDK + context. The default value disables the + :ref:`buildhistory <ref-classes-buildhistory>` and + :ref:`icecc <ref-classes-icecc>` classes. Additionally, the contents of ``conf/sdk-extra.conf``, when present, are appended to the end of ``conf/local.conf`` within the produced SDK,
Signature · 1 line
2.34.1
PATCH 3/3 ref-manual/classes.rst: remove reference to sip.bbclass
In reply to [email protected]From: Michael Opdenacker <[email protected]>
Removed in version 2.2
Signed-off-by Michael Opdenacker <[email protected]>
--- documentation/ref-manual/classes.rst | 8 -------- 1 file changed, 8 deletions(-)
documentation/ref-manual/classes.rst +0 -8
@@ -2591,14 +2591,6 @@ in the :ref:`setuptools3 <ref-classes-setuptools3>` class and inherit this class The :ref:`sign_rpm <ref-classes-sign_rpm>` class supports generating signed RPM packages. -.. _ref-classes-sip: - -``sip.bbclass`` -=============== - -The :ref:`sip <ref-classes-sip>` class supports recipes that build or package SIP-based -Python bindings. - .. _ref-classes-siteconfig: ``siteconfig.bbclass``
Signature · 1 line
2.34.1