@@ -20,3 +20,7 @@ If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake,
issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The
:yocto_lists:`yocto </g/yocto>` mailing list is a general "catch-all" location
where questions can be sent if you can't work out where something should go.
+
+.. only:: splithtml
+
+ .. tags:: contributing
@@ -440,3 +440,7 @@ you can use `Git` configuration settings::
.. note::
Patches generated or updated by ``devtool`` are created with no signature.
+
+.. only:: splithtml
+
+ .. tags:: contributing, conventions
@@ -65,3 +65,7 @@ medium and long term. We do encourage people to file bugs so issues are
at least known about. It helps other users when they find somebody having
the same issue as they do, and an issue that is unknown is much less likely
to ever be fixed!
+
+.. only:: splithtml
+
+ .. tags:: contributing
@@ -898,3 +898,7 @@ Foundation policy, specifically:
Additionally, the contributor should provide notice and attribution of such
third party rights, along with information about the applicable license
terms, with their contribution.
+
+.. only:: splithtml
+
+ .. tags:: contributing
@@ -54,3 +54,7 @@ command:
# This is a comment, not a command to run as root.
$ bitbake core-image-minimal
+
+.. only:: splithtml
+
+ .. tags:: conventions
@@ -127,3 +127,6 @@ the following::
SIGGEN_LOCKEDSIGS_x86_64 += "python3-native:do_create_manifest:24f0abbec221d27bbb2909b6e846288b12cab419f1faf9f5006ed80423d37e28"
SIGGEN_LOCKEDSIGS_x86_64 += "python3-native:do_addto_recipe_sysroot:bcb6a1905f113128de3f88d702b706befd6a786267c045ee82532759a7c214d7"
+.. only:: splithtml
+
+ .. tags:: host-configuration, cli-tool
@@ -64,3 +64,7 @@ For help on the ``bmaptool`` command, use the following command::
is simply a transitional package which exists solely to
ensure backward compatibility and smooth upgrades from
older installations.
+
+.. only:: splithtml
+
+ .. tags:: cli-tool, flashing
@@ -406,3 +406,6 @@ Here is a sample screenshot of the interface:
.. image:: figures/buildhistory-web.png
:width: 100%
+.. only:: splithtml
+
+ .. tags:: cli-tool, build-configuration
@@ -852,3 +852,6 @@ directory:
those recipes to set :term:`SRCREV` to specific versions of the
software.
+.. only:: splithtml
+
+ .. tags:: build-configuration
@@ -144,3 +144,7 @@ You can then use the :ref:`ref-bitbake-config-build-enable-fragment` command to
set a value to the ``CUSTOM_VARIABLE`` variable::
$ bitbake-config-build enable-fragment custom-builtin-fragment/somevalue
+
+.. only:: splithtml
+
+ .. tags:: build-configuration, config-fragments
@@ -139,3 +139,7 @@ This is fine, however if you do this you should keep the following in mind:
- More generally, the Poky distribution configuration enables a lot more
than you likely need for your production use case. You should evaluate *every*
configuration choice made in your copy to determine if it is needed.
+
+.. only:: splithtml
+
+ .. tags:: build-configuration, distro
@@ -50,3 +50,6 @@ when running the ``oe-init-build-env`` setup script. These can be
edited further if needed to improve or change the build configurations
available to the users, and provide useful summaries and detailed usage notes.
+.. only:: splithtml
+
+ .. tags:: build-configuration
@@ -220,3 +220,6 @@ unsets the variable in a configuration file::
Having no default hostname in the filesystem is suitable for
environments that use dynamic hostnames such as virtual machines.
+.. only:: splithtml
+
+ .. tags:: image-customization
@@ -1276,3 +1276,6 @@ Here are some other tips that you might find useful:
that are purely internal and have a limited scope (e.g. internal
variables used to implement a single ``.bbclass`` file).
+.. only:: splithtml
+
+ .. tags:: debugging
@@ -80,3 +80,6 @@ terminal window.
- It is also worth noting that ``devshell`` still works over X11
forwarding and similar situations.
+.. only:: splithtml
+
+ .. tags:: debugging
@@ -72,3 +72,6 @@ your :ref:`structure-build-conf-local.conf` configuration file::
# VIRTUAL-RUNTIME_dev_manager = "busybox-mdev"
# VIRTUAL-RUNTIME_dev_manager = "systemd"
+.. only:: splithtml
+
+ .. tags:: build-configuration
@@ -1760,3 +1760,7 @@ target machine.
device (e.g. RPM or OPKG). Consequently, you should not intermingle
``devtool deploy-target`` and package manager operations on the target
device. Doing so could result in a conflicting set of files.
+
+.. only:: splithtml
+
+ .. tags:: app-dev, cli-tool, devtool
@@ -59,3 +59,7 @@ Run ``sstate-cache-management.py`` for more details about this script.
As this command is much more cautious and selective, removing only cache files,
it will execute much slower than the simple ``find`` command described above.
Therefore, it may not be your best option to trim huge cache directories.
+
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -66,3 +66,6 @@ variation of the BitBake command guarantees that you have all the
sources for that BitBake target should you disconnect from the Internet
and want to do the build later offline.
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -81,3 +81,6 @@ If you want to set up your own error reporting server, you can obtain
the code from the Git repository at :yocto_git:`/error-report-web/`.
Instructions on how to set it up are in the README document.
+.. only:: splithtml
+
+ .. tags:: cli-tool, contributing, debugging
@@ -69,3 +69,6 @@ development source for numerous packages.
The ``poky-bleeding`` distribution is not tested on a regular basis. Keep
this in mind if you use it.
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -40,3 +40,7 @@ supporting GNU toolchains released by ARM.
You can find further information by reading about the :term:`TCMODE` variable
in the Yocto Project Reference Manual's variable glossary.
+
+.. only:: splithtml
+
+ .. tags:: toolchains
@@ -153,3 +153,6 @@ Here are know issues in GObject Introspection Support:
under 32-bit host machines. In particular, "qemumips64" is known to
not work under i686.
+.. only:: splithtml
+
+ .. tags:: target-configuration
@@ -127,3 +127,7 @@ This will make Hash Equivalence related changes be printed on the console, such
as::
NOTE: Task <recipe.bb>:do_<task> unihash changed to dc0da29c62a2d78d8d853fbb9c173778fe7d6fa4a68c67494b17afffe8ca1894
+
+.. only:: splithtml
+
+ .. tags:: hash-equivalence, host-configuration
@@ -160,3 +160,7 @@ increasing levels of complexity and functionality:
.. [#footnote-systemd-size] Using systemd increases the ``core-image-minimal``
image size by 160\% for ``qemux86-64`` on Mickledore (4.2), compared to SysVinit.
+
+.. only:: splithtml
+
+ .. tags:: target-configuration
@@ -986,3 +986,6 @@ above:
Both the ``create-layers-setup`` and the ``setup-layers`` provided several additional options
that customize their behavior - you are welcome to study them via ``--help`` command line parameter.
+.. only:: splithtml
+
+ .. tags:: oe-concepts
@@ -236,3 +236,6 @@ the following in your recipe::
DEPENDS = "clutter-1.8"
+.. only:: splithtml
+
+ .. tags:: libraries, target-configuration
@@ -531,3 +531,6 @@ the license from the fetched source::
NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt"
+.. only:: splithtml
+
+ .. tags:: license-compliance, target-configuration
@@ -147,3 +147,7 @@ details.
This variable has no effect when any of :term:`BB_PRESSURE_MAX_CPU`,
:term:`BB_PRESSURE_MAX_IO` or :term:`BB_PRESSURE_MAX_MEMORY` is set, as it
was designed for systems that do not have pressure information available.
+
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -310,3 +310,7 @@ We can then add a :ref:`ref-tasks-install` task to ``my-parent-firmware``::
Doing the above will allow the firmware binary to be transferred and packaged
into the Linux context and rootfs.
+
+.. only:: splithtml
+
+ .. tags:: multiconfig, toolchains
@@ -116,3 +116,6 @@ Here is an example for "qemuarm" machine::
DISPLAY_DPI=150
DISPLAY_SUBPIXEL_ORDER=vrgb
+.. only:: splithtml
+
+ .. tags:: oe-concepts
@@ -1676,3 +1676,6 @@ in the BitBake User Manual.
might wish to use. If in doubt, you should check with multiple
implementations --- including those from BusyBox.
+.. only:: splithtml
+
+ .. tags:: oe-concepts
@@ -1171,3 +1171,6 @@ packages::
PACKAGE_ADD_METADATA_IPK = "Vendor: CustomIpk\nGroup:Applications/Spreadsheets"
+.. only:: splithtml
+
+ .. tags:: packaging
@@ -160,3 +160,7 @@ an entire Linux distribution, including the toolchain, from source.
#. **Exit QEMU:** Exit QEMU by either clicking on the shutdown icon or by typing
``Ctrl-C`` in the QEMU transcript window from which you evoked QEMU.
+
+.. only:: splithtml
+
+ .. tags:: build-configuration
@@ -207,3 +207,6 @@ versioned library example. The "magic" is setting the :term:`SOLIBS` and
install -m 0755 ${UNPACKDIR}/libfoo.so ${D}${libdir}
}
+.. only:: splithtml
+
+ .. tags:: libraries
@@ -47,3 +47,6 @@ controls what type of shell is opened.
When you are finished using ``pydevshell``, you can exit the shell
either by using Ctrl+d or closing the terminal window.
+.. only:: splithtml
+
+ .. tags:: debugging
@@ -477,3 +477,7 @@ command line:
readable or writable and "slirp-enabled".
- ``publicvnc``: Enables a VNC server open to all hosts.
+
+.. only:: splithtml
+
+ .. tags:: debugging, qemu
@@ -87,3 +87,6 @@ Follow these general steps:
SRC_URI += "file://my_changes.patch"
+.. only:: splithtml
+
+ .. tags:: app-dev, cli-tool
@@ -96,3 +96,7 @@ See also Joshua Watt's presentations
at FOSDEM 2023 and
`SPDX in the Yocto Project <https://fosdem.org/2024/schedule/event/fosdem-2024-3318-spdx-in-the-yocto-project/>`__
at FOSDEM 2024.
+
+.. only:: splithtml
+
+ .. tags:: license-compliance, security
@@ -107,3 +107,6 @@ that can help you speed up the build:
the static libraries. If so, you might need to exclude them as
well.
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -192,3 +192,7 @@ module, the following logs are shown:
Some artifacts may be found (returning 200 above). Some others will not be found
because the expected artifacts on the client is not present on the server, in
which case the client will rebuild the task (and its dependencies).
+
+.. only:: splithtml
+
+ .. tags:: host-configuration, sstate
@@ -537,3 +537,7 @@ Where To Go From Here
- Configure your build: follow :ref:`overview-manual/concepts:User Configuration`.
- Learn how and what to build with :term:`BitBake`: follow :doc:`/dev-manual/building`.
+
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -73,3 +73,7 @@ build system uses to build the package would be as follows::
To learn how to use ``devtool`` to add, modify, upgrade recipes and more,
see the :ref:`dev-manual/devtool:Using the \`\`devtool\`\` command-line tool`
section of this Development Tasks Manual.
+
+.. only:: splithtml
+
+ .. tags:: debugging
@@ -397,3 +397,6 @@ To manually upgrade recipe versions, follow these general steps:
builds work and any testing is successful, you can create commits for
any changes in the layer holding your upgraded recipe.
+.. only:: splithtml
+
+ .. tags:: devtool
@@ -88,3 +88,6 @@ the CLI, you need to do the following after your image is built:
user@machine:~$ weston
+.. only:: splithtml
+
+ .. tags:: image-customization
@@ -795,3 +795,6 @@ the existing kernel, and then inserts a new kernel:
Using ``bmaptool`` is generally 10 to 20 times faster than using ``dd``.
+.. only:: splithtml
+
+ .. tags:: cli-tool, flashing, wic
@@ -52,3 +52,6 @@ the x32 psABI. Here is an example::
$ bitbake core-image-sato
+.. only:: splithtml
+
+ .. tags:: target-configuration
@@ -17,4 +17,8 @@ Yocto Project Linux Kernel Development Manual
maint-appx
faq
+.. only:: splithtml
+
+ .. tags:: linux-kernel
+
.. include:: /boilerplate.rst
@@ -2371,3 +2371,7 @@ executes to accomplish that.
.. image:: svg/bitbake_tasks_map.*
:width: 100%
+
+.. only:: splithtml
+
+ .. tags:: fakeroot, hash-equivalence, oe-concepts, pseudo, toolchains, sstate
@@ -630,3 +630,7 @@ source licensing during the lifecycle of a product created using the
Yocto Project, see the
":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`"
section in the Yocto Project Development Tasks Manual.
+
+.. only:: splithtml
+
+ .. tags:: host-configuration
@@ -751,3 +751,7 @@ helpful for getting started:
dependencies for libraries or for other recipes as well as
configuration and compilation options. Related recipes are
consolidated into a layer.
+
+.. only:: splithtml
+
+ .. tags:: oe-concepts
@@ -15,4 +15,8 @@ Yocto Project Profiling and Tracing Manual
usage
examples
+.. only:: splithtml
+
+ .. tags:: debugging, profiling
+
.. include:: /boilerplate.rst
@@ -690,3 +690,7 @@ and create a remote debugging configuration for the recipe. Similarly to
For further details on the ``devtool ide-sdk`` command, see the
":doc:`/sdk-manual/extensible`" chapter in the Yocto Project Application
Development and the Extensible Software Development Kit (eSDK) manual.
+
+.. only:: splithtml
+
+ .. tags:: devtool
@@ -289,3 +289,7 @@ The ``core/yocto-autobuilder/multilib-x86-lib64`` fragment enables
:ref:`multilib <dev-manual/libraries:Combining Multiple Versions of Library
Files into One Image>` configurations for supporting 64-bit libraries on 32-bit
:wikipedia:`X86 <X86>` builds.
+
+.. only:: splithtml
+
+ .. tags:: cli-tool, config-fragments
@@ -243,3 +243,7 @@ the current file. For example:
include common.wks.inc
bootloader --configfile="directdisk-bootloader-config.cfg"
+
+.. only:: splithtml
+
+ .. tags:: wic
@@ -389,3 +389,7 @@ takes the Autobuilder workers several hours.
Finally, in addition to the Autobuilder's tests, the Yocto Project QA
team also performs testing on a variety of platforms, which includes
actual hardware, to ensure expected results.
+
+.. only:: splithtml
+
+ .. tags:: release-process
@@ -18,4 +18,8 @@ Yocto Project Application Development and Software Development Kits (SDK/eSDK) M
appendix-customizing
appendix-customizing-standard
+.. only:: splithtml
+
+ .. tags:: sdk, toolchains
+
.. include:: /boilerplate.rst
@@ -48,3 +48,7 @@ consider that:
being set up in such a way that if such an issue were ever discovered, which at
some point could happen, the build environments themselves could be simply
destroyed and rebuilt cleanly, i.e. they're disposable.
+
+.. only:: splithtml
+
+ .. tags:: security
@@ -87,3 +87,6 @@ make sure that you configure processes and applications that attempt
these types of writes do so to directories with write access (e.g.
``/tmp`` or ``/var/run``).
+.. only:: splithtml
+
+ .. tags:: security
@@ -138,3 +138,6 @@ The Yocto Project provides tools for making your image more secure. You
can find these tools in the ``meta-security`` layer of the
:yocto_git:`Yocto Project Source Repositories <>`.
+.. only:: splithtml
+
+ .. tags:: security
@@ -283,3 +283,7 @@ Let's verify that signature verification works:
As you can see, this does not prevent :term:`BitBake` from continuing, but
the real task is executed instead of re-using the shared state.
+
+.. only:: splithtml
+
+ .. tags:: host-configuration, security, sstate
@@ -515,3 +515,6 @@ Example of output for a CVE rejected by the Linux CNA:
"description": "Rejected by CNA"
}
+.. only:: splithtml
+
+ .. tags:: security
@@ -11,4 +11,8 @@ Yocto Project Security Reference
security-team
reporting-vulnerabilities
+.. only:: splithtml
+
+ .. tags:: security
+
.. include:: /boilerplate.rst
@@ -184,3 +184,7 @@ test. Here is what you have to do for each recipe:
``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.
+
+.. only:: splithtml
+
+ .. tags:: runtime-testing
@@ -165,3 +165,7 @@ You can have finer control on the test with:
- :term:`OEQA_REPRODUCIBLE_TEST_TARGET`: lists recipes to be built,
- :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS`: lists recipes that will
be built using :ref:`Shared State <overview-manual/concepts:Shared State>`.
+
+.. only:: splithtml
+
+ .. tags:: reproducibility
@@ -598,3 +598,6 @@ Once the test is complete, the packages are removed from the DUT::
]
}
+.. only:: splithtml
+
+ .. tags:: runtime-testing
@@ -97,3 +97,7 @@ The next steps include:
- A final decision on whether to release is made by the YP TSC who have
final oversight on release readiness.
+
+.. only:: splithtml
+
+ .. tags:: release-process
@@ -15,4 +15,8 @@ Toaster User Manual
setup-and-use
reference
+.. only:: splithtml
+
+ .. tags:: host-configuration
+
.. include:: /boilerplate.rst
Make use of the sphinx-tags extension to tag section with category. After this commit, the following tags (with appearance count) are created: - app-dev (2) - build-configuration (7) - cli-tool (8) - config-fragments (2) - contributing (5) - conventions (2) - debugging (7) - devtool (3) - distro (1) - fakeroot (1) - flashing (2) - hash-equivalence (2) - host-configuration (12) - image-customization (2) - libraries (2) - license-compliance (2) - linux-kernel (1) - multiconfig (1) - oe-concepts (5) - packaging (1) - profiling (1) - pseudo (1) - qemu (1) - release-process (2) - reproducibility (1) - runtime-testing (2) - sdk (1) - security (7) - sstate (3) - target-configuration (5) - toolchains (4) - wic (2) The rationale was to create distinctive tags that could allow sections from different parts of the documentation to be linked together. Some tags only have one count: those still improve discoverability when looking at the tags overview page. Tags are only compatible with the regular HTML build (not singlehtml or epub). For that reason use the .. only directive to show them only for splithtml. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- documentation/contributor-guide/identify-component.rst | 4 ++++ documentation/contributor-guide/recipe-style-guide.rst | 4 ++++ documentation/contributor-guide/report-defect.rst | 4 ++++ documentation/contributor-guide/submit-changes.rst | 4 ++++ documentation/conventions.rst | 4 ++++ documentation/dev-manual/bblock.rst | 3 +++ documentation/dev-manual/bmaptool.rst | 4 ++++ documentation/dev-manual/build-quality.rst | 3 +++ documentation/dev-manual/building.rst | 3 +++ documentation/dev-manual/creating-fragments.rst | 4 ++++ documentation/dev-manual/custom-distribution.rst | 4 ++++ documentation/dev-manual/custom-template-configuration-directory.rst | 3 +++ documentation/dev-manual/customizing-images.rst | 3 +++ documentation/dev-manual/debugging.rst | 3 +++ documentation/dev-manual/development-shell.rst | 3 +++ documentation/dev-manual/device-manager.rst | 3 +++ documentation/dev-manual/devtool.rst | 4 ++++ documentation/dev-manual/disk-space.rst | 4 ++++ documentation/dev-manual/efficiently-fetching-sources.rst | 3 +++ documentation/dev-manual/error-reporting-tool.rst | 3 +++ documentation/dev-manual/external-scm.rst | 3 +++ documentation/dev-manual/external-toolchain.rst | 4 ++++ documentation/dev-manual/gobject-introspection.rst | 3 +++ documentation/dev-manual/hashequivserver.rst | 4 ++++ documentation/dev-manual/init-manager.rst | 4 ++++ documentation/dev-manual/layers.rst | 3 +++ documentation/dev-manual/libraries.rst | 3 +++ documentation/dev-manual/licenses.rst | 3 +++ documentation/dev-manual/limiting-resources.rst | 4 ++++ documentation/dev-manual/multiconfig.rst | 4 ++++ documentation/dev-manual/new-machine.rst | 3 +++ documentation/dev-manual/new-recipe.rst | 3 +++ documentation/dev-manual/packages.rst | 3 +++ documentation/dev-manual/poky-manual-setup.rst | 4 ++++ documentation/dev-manual/prebuilt-libraries.rst | 3 +++ documentation/dev-manual/python-development-shell.rst | 3 +++ documentation/dev-manual/qemu.rst | 4 ++++ documentation/dev-manual/quilt.rst | 3 +++ documentation/dev-manual/sbom.rst | 4 ++++ documentation/dev-manual/speeding-up-build.rst | 3 +++ documentation/dev-manual/sstate-mirrors-setup.rst | 4 ++++ documentation/dev-manual/start.rst | 4 ++++ documentation/dev-manual/temporary-source-code.rst | 4 ++++ documentation/dev-manual/upgrading-recipes.rst | 3 +++ documentation/dev-manual/wayland.rst | 3 +++ documentation/dev-manual/wic.rst | 3 +++ documentation/dev-manual/x32-psabi.rst | 3 +++ documentation/kernel-dev/index.rst | 4 ++++ documentation/overview-manual/concepts.rst | 4 ++++ documentation/overview-manual/development-environment.rst | 4 ++++ documentation/overview-manual/yp-intro.rst | 4 ++++ documentation/profile-manual/index.rst | 4 ++++ documentation/ref-manual/devtool-reference.rst | 4 ++++ documentation/ref-manual/fragments.rst | 4 ++++ documentation/ref-manual/kickstart.rst | 4 ++++ documentation/ref-manual/release-process.rst | 4 ++++ documentation/sdk-manual/index.rst | 4 ++++ documentation/security-manual/build-process-security.rst | 4 ++++ documentation/security-manual/read-only-rootfs.rst | 3 +++ documentation/security-manual/securing-images.rst | 3 +++ documentation/security-manual/sstate-signing.rst | 4 ++++ documentation/security-manual/vulnerabilities.rst | 3 +++ documentation/security-reference/index.rst | 4 ++++ documentation/test-manual/ptest.rst | 4 ++++ documentation/test-manual/reproducible-builds.rst | 4 ++++ documentation/test-manual/runtime-testing.rst | 3 +++ documentation/test-manual/test-process.rst | 4 ++++ documentation/toaster-manual/index.rst | 4 ++++ 68 files changed, 242 insertions(+)