@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
-Maintaining Build Output Quality
-********************************
+Maintaining Build Output Quality with ``buildhistory``
+******************************************************
Many factors can influence the quality of a build. For example, if you
upgrade a recipe to use a new version of an upstream software package or
@@ -839,7 +839,7 @@ directory:
still use the recipes in an offline build. Do the following:
#. Use a configuration generated by enabling :ref:`build
- history <dev-manual/build-quality:maintaining build output quality>`.
+ history <dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\`>`.
#. Use the ``buildhistory-collect-srcrevs`` command to collect the
stored :term:`SRCREV` values from the build's history. For more
@@ -194,7 +194,7 @@ each building system's ``local.conf`` file::
For information on build
history, see the
-":ref:`dev-manual/build-quality:maintaining build output quality`" section.
+":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``" section.
.. note::
@@ -101,7 +101,7 @@ The following steps describe how to set up the AUH utility:
configurations:
- If you want to enable :ref:`Build
- History <dev-manual/build-quality:maintaining build output quality>`,
+ History <dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\`>`,
which is optional, you need the following lines in the
``conf/local.conf`` file::
@@ -271,7 +271,7 @@ The changes to Build History are:
option for each utility for more information on the new syntax.
For more information on Build History, see the
-":ref:`dev-manual/build-quality:maintaining build output quality`"
+":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``"
section in the Yocto Project Development Tasks Manual.
.. _migration-1.5-udev:
@@ -216,7 +216,7 @@ The following miscellaneous change occurred:
should manually remove old "build-id" files from your existing build
history repositories to avoid confusion. For information on the build
history feature, see the
- ":ref:`dev-manual/build-quality:maintaining build output quality`"
+ ":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``"
section in the Yocto Project Development Tasks Manual.
@@ -105,4 +105,4 @@ any new Yocto Project release.
:ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``.
For more information on using :ref:`ref-classes-buildhistory`, see
- :ref:`dev-manual/build-quality:maintaining build output quality`.
+ :ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``.
@@ -270,7 +270,7 @@ The :ref:`ref-classes-buildhistory` class records a history of build output meta
which can be used to detect possible regressions as well as used for
analysis of the build output. For more information on using Build
History, see the
-":ref:`dev-manual/build-quality:maintaining build output quality`"
+":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``"
section in the Yocto Project Development Tasks Manual.
.. _ref-classes-buildstats:
@@ -267,7 +267,7 @@ The OpenEmbedded build system creates this directory when you enable
build history via the :ref:`ref-classes-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/build-quality:maintaining build output quality`"
+":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``"
section in the Yocto Project Development Tasks Manual.
.. _structure-build-cache:
@@ -1394,7 +1394,7 @@ system and gives an overview of their function and contents.
When inheriting the :ref:`ref-classes-buildhistory`
class, this variable specifies the build history features to be
enabled. For more information on how build history works, see the
- ":ref:`dev-manual/build-quality:maintaining build output quality`"
+ ":ref:`dev-manual/build-quality:maintaining build output quality with \`\`buildhistory\`\``"
section in the Yocto Project Development Tasks Manual.
You can specify these features in the form of a space-separated list:
Since the section "Maintaining Build Output Quality" is really only about the "buildhistory" feature, rename the section to make that clear, and update all references to the new name. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> ---