diff mbox series

dev-manual: rename Build Quality section to mention "buildhistory"

Message ID dfe0ece3-617a-02c8-d1bb-1baa904d2988@crashcourse.ca
State Under Review
Headers show
Series dev-manual: rename Build Quality section to mention "buildhistory" | expand

Commit Message

Robert P. J. Day June 25, 2026, 9:47 a.m. UTC
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>

---
diff mbox series

Patch

diff --git a/documentation/dev-manual/build-quality.rst b/documentation/dev-manual/build-quality.rst
index c3c7ccbb2..c2e46b69c 100644
--- a/documentation/dev-manual/build-quality.rst
+++ b/documentation/dev-manual/build-quality.rst
@@ -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
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index c8bb31b92..60cb22785 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -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
diff --git a/documentation/dev-manual/packages.rst b/documentation/dev-manual/packages.rst
index 500639565..c75584c93 100644
--- a/documentation/dev-manual/packages.rst
+++ b/documentation/dev-manual/packages.rst
@@ -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::

diff --git a/documentation/dev-manual/upgrading-recipes.rst b/documentation/dev-manual/upgrading-recipes.rst
index 01fd12d86..d0c322546 100644
--- a/documentation/dev-manual/upgrading-recipes.rst
+++ b/documentation/dev-manual/upgrading-recipes.rst
@@ -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::

diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index da26cca63..c21b52cf2 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -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:
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst
index ca8222098..1a5704fd4 100644
--- a/documentation/migration-guides/migration-1.7.rst
+++ b/documentation/migration-guides/migration-1.7.rst
@@ -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.


diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst
index 1820f5cfd..1671992a8 100644
--- a/documentation/migration-guides/migration-general.rst
+++ b/documentation/migration-guides/migration-general.rst
@@ -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\`\``.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 56a8e7e98..7b220a284 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -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:
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 31faec1c9..57f19a82f 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -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:
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index c808c095e..b4c6bc957 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -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: