diff mbox series

[12/30] manuals: add references to "do_package_write_*" tasks

Message ID 20220923175219.6652-13-michael.opdenacker@bootlin.com
State New
Headers show
Series manuals: add missing references to tasks | expand

Commit Message

Michael Opdenacker Sept. 23, 2022, 5:52 p.m. UTC
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Using a reference to "do_package_write_deb", the first entry
in the list.

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
 documentation/dev-manual/common-tasks.rst  | 2 +-
 documentation/overview-manual/concepts.rst | 4 ++--
 documentation/ref-manual/classes.rst       | 2 +-
 documentation/ref-manual/tasks.rst         | 2 +-
 documentation/ref-manual/variables.rst     | 4 ++--
 5 files changed, 7 insertions(+), 7 deletions(-)
diff mbox series


diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 947e10560a..dbf7dad558 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -9635,7 +9635,7 @@  Running Specific Tasks
 Any given recipe consists of a set of tasks. The standard BitBake
 behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, :ref:`ref-tasks-patch`,
 :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`,
-``do_package_write_*``, and :ref:`ref-tasks-build`. The default task is
+:ref:`do_package_write_* <ref-tasks-package_write_deb>`, and :ref:`ref-tasks-build`. The default task is
 :ref:`ref-tasks-build` and any tasks on which it depends build first. Some tasks,
 such as ``do_devshell``, are not part of the default build chain. If you
 wish to run a task that is not part of the default build chain, you can
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index f1457522da..a477139996 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1198,7 +1198,7 @@  the work involved would be equal to or greater than the underlying task.
 In the build system, the common tasks that have setscene variants are
+:ref:`do_package_write_* <ref-tasks-package_write_deb>`,
 :ref:`ref-tasks-packagedata`, and
@@ -1215,7 +1215,7 @@  to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, :ref:`ref-tasks-patch`,
 It becomes more complicated if everything can come from an sstate cache
 because some objects are simply not required at all. For example, you do
 not need a compiler or native tools, such as quilt, if there isn't anything
-to compile or patch. If the ``do_package_write_*`` packages are available
+to compile or patch. If the :ref:`do_package_write_* <ref-tasks-package_write_deb>` packages are available
 from sstate, BitBake does not need the :ref:`ref-tasks-package` task data.
 To handle all these complexities, BitBake runs in two phases. The first
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 076ebb31ae..977dc34523 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -47,7 +47,7 @@  splitting out of debug symbols during packaging).
    even if the recipes do not produce architecture-specific output.
    Configuring such recipes for all architectures causes the
-   ``do_package_write_*`` tasks to
+   :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks to
    have different signatures for the machines with different tunings.
    Additionally, unnecessary rebuilds occur every time an image for a
    different :term:`MACHINE` is built even when the recipe never changes.
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index f0129c1f72..b099ce7a5c 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -170,7 +170,7 @@  Copies files that are to be packaged into the holding area
 working directory set to ``${``\ :term:`B`\ ``}``, which is the
 compilation directory. The :ref:`ref-tasks-install` task, as well as other tasks
 that either directly or indirectly depend on the installed files (e.g.
-:ref:`ref-tasks-package`, ``do_package_write_*``, and
+:ref:`ref-tasks-package`, :ref:`do_package_write_* <ref-tasks-package_write_deb>`, and
 :ref:`ref-tasks-rootfs`), run under
 :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 45d058a281..272673d90b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6200,7 +6200,7 @@  system and gives an overview of their function and contents.
       The practical effect of the above :term:`RDEPENDS` assignment is that
       ``bar`` and ``baz`` will be declared as dependencies inside the
       package ``foo`` when it is written out by one of the
-      :ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks.
+      :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks.
       Exactly how this is done depends on which package format is used,
       which is determined by
       :term:`PACKAGE_CLASSES`. When the
@@ -6212,7 +6212,7 @@  system and gives an overview of their function and contents.
       added. This dependency is from the recipe's
       :ref:`ref-tasks-build` (not to be confused with
       :ref:`ref-tasks-compile`) task to the
-      ``do_package_write_*`` task of the recipes that build ``bar`` and
+      :ref:`do_package_write_* <ref-tasks-package_write_deb>` task of the recipes that build ``bar`` and
       The names of the packages you list within :term:`RDEPENDS` must be the