public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	Quentin Schulz <foss@0leil.net>
Subject: [PATCH 04/30] manuals: add reference to "do_configure" task
Date: Fri, 23 Sep 2022 19:51:53 +0200	[thread overview]
Message-ID: <20220923175219.6652-5-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com>

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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

diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 7b20234991..61755dd06e 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -2551,7 +2551,7 @@ doing the following:
    ``${``\ :term:`S`\ ``}``.
 
    If ``${S}`` might contain a Makefile, or if you inherit some class
-   that replaces ``do_configure`` and ``do_compile`` with custom
+   that replaces :ref:`ref-tasks-configure` and ``do_compile`` with custom
    versions, then you can use the
    ``[``\ :ref:`noexec <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
    flag to turn the tasks into no-ops, as follows::
@@ -2881,7 +2881,7 @@ you can use as references.
 If you are creating a new kernel recipe, normal recipe-writing rules
 apply for setting up a :term:`SRC_URI`. Thus, you need to specify any
 necessary patches and set :term:`S` to point at the source code. You need to
-create a ``do_configure`` task that configures the unpacked kernel with
+create a :ref:`ref-tasks-configure` task that configures the unpacked kernel with
 a ``defconfig`` file. You can do this by using a ``make defconfig``
 command or, more commonly, by copying in a suitable ``defconfig`` file
 and then running ``make oldconfig``. By making use of ``inherit kernel``
@@ -9634,7 +9634,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``, ``do_patch``,
-``do_configure``, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``,
+:ref:`ref-tasks-configure`, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``,
 ``do_package_write_*``, 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
diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst
index 51a13873e2..546c798196 100644
--- a/documentation/migration-guides/migration-1.8.rst
+++ b/documentation/migration-guides/migration-1.8.rst
@@ -128,7 +128,7 @@ when the :ref:`ref-tasks-configure` task needs to be
 re-executed.
 
 One of the improvements is to attempt to run "make clean" during the
-``do_configure`` task if a ``Makefile`` exists. Some software packages
+:ref:`ref-tasks-configure` task if a ``Makefile`` exists. Some software packages
 do not provide a working clean target within their make files. If you
 have such recipes, you need to set
 :term:`CLEANBROKEN` to "1" within the recipe, for example::
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst
index b2d8a0b678..bfc600ccca 100644
--- a/documentation/migration-guides/migration-2.1.rst
+++ b/documentation/migration-guides/migration-2.1.rst
@@ -108,12 +108,12 @@ this change should not be a problem. However, if you have a recipe that
 bypasses the standard :ref:`ref-tasks-configure` task
 from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building
 uses a very old version of ``autoconf``, the recipe might be incapable
-of determining the correct size of ``off_t`` during ``do_configure``.
+of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`.
 
 The best course of action is to patch the software as necessary to allow
 the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such
 that ``autoreconf`` succeeds and produces a working configure script,
-and to remove the overridden ``do_configure`` task such that the default
+and to remove the overridden :ref:`ref-tasks-configure` task such that the default
 implementation does get used.
 
 .. _migration-2.1-image-generation-split-out-from-filesystem-generation:
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst
index 11e659de7c..32bb48bccc 100644
--- a/documentation/migration-guides/migration-2.6.rst
+++ b/documentation/migration-guides/migration-2.6.rst
@@ -135,7 +135,7 @@ Fetching these types of dependencies that are not provided in the
 sysroot negatively affects the ability to reproduce builds. This type of
 fetching is now explicitly disabled. Consequently, any missing
 dependencies in Python recipes that use these classes now result in an
-error during the ``do_configure`` task.
+error during the :ref:`ref-tasks-configure` task.
 
 .. _migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported:
 
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 2e1aa3df48..858118beec 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -1209,7 +1209,7 @@ The build system has knowledge of the relationship between these tasks
 and other preceding tasks. For example, if BitBake runs
 ``do_populate_sysroot_setscene`` for something, it does not make sense
 to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``,
-``do_configure``, ``do_compile``, and :ref:`ref-tasks-install` tasks. However, if
+:ref:`ref-tasks-configure`, ``do_compile``, and :ref:`ref-tasks-install` tasks. However, if
 ``do_package`` needs to be run, BitBake needs to run those other tasks.
 
 It becomes more complicated if everything can come from an sstate cache
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index f3aebcecc3..16715984ae 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -58,7 +58,7 @@ The default behavior of this task is to run ``oe_runmake clean`` if a
 makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
 :term:`CLEANBROKEN` is not set to "1". If no such
 file is found or the :term:`CLEANBROKEN` variable is set to "1", the
-``do_configure`` task does nothing.
+:ref:`ref-tasks-configure` task does nothing.
 
 .. _ref-tasks-configure_ptest_base:
 
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 060bf499bb..bc29b5a05b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1620,7 +1620,7 @@ system and gives an overview of their function and contents.
       the appropriate staging sysroot, given by the
       :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time the
       :ref:`ref-tasks-configure` task for ``foo`` runs.
-      This mechanism is implemented by having ``do_configure`` depend on
+      This mechanism is implemented by having :ref:`ref-tasks-configure` depend on
       the :ref:`ref-tasks-populate_sysroot` task of
       each recipe listed in :term:`DEPENDS`, through a
       ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]``
-- 
2.34.1



  parent reply	other threads:[~2022-09-23 17:52 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-23 17:51 [PATCH 00/30] manuals: add missing references to tasks michael.opdenacker
2022-09-23 17:51 ` [PATCH 01/30] manuals: add references to the "do_fetch" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 03/30] manuals: add references to the "do_build" task michael.opdenacker
2022-09-23 17:51 ` michael.opdenacker [this message]
2022-09-26 13:57   ` [docs] [PATCH 04/30] manuals: add reference to "do_configure" task Quentin Schulz
2022-10-05 18:01     ` Michael Opdenacker
2022-09-23 17:51 ` [PATCH 05/30] manuals: add reference to the "do_compile" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 06/30] manuals: add references to the "do_deploy" task michael.opdenacker
2022-09-26 13:40   ` [docs] " Quentin Schulz
     [not found]     ` <06a1c1e5-0a0c-5c0f-d05e-6e51967be786@bootlin.com>
2022-10-06  7:49       ` Quentin Schulz
2022-09-26 14:04   ` Quentin Schulz
2022-10-05 18:11     ` Michael Opdenacker
2022-10-06  7:54       ` Quentin Schulz
2022-09-23 17:51 ` [PATCH 07/30] manuals: add references to the "do_image" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 08/30] manuals: add references to the "do_package" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 09/30] manuals: add references to the "do_package_qa" task michael.opdenacker
2022-09-23 17:51 ` [PATCH 10/30] overview-manual: concepts.rst: add reference to "do_packagedata" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 11/30] manuals: add references to the "do_patch" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 12/30] manuals: add references to "do_package_write_*" tasks michael.opdenacker
2022-09-23 17:52 ` [PATCH 13/30] ref-manual: variables.rst: add reference to "do_populate_lic" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 14/30] manuals: add reference to the "do_populate_sdk" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 15/30] overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 16/30] manuals: add references to "do_populate_sysroot" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 17/30] manuals: add references to the "do_unpack" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 18/30] dev-manual: common-tasks.rst: add reference to "do_clean" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 19/30] manuals: add references to the "do_cleanall" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 20/30] ref-manual: tasks.rst: add references to the "do_cleansstate" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 21/30] manuals: add references to the "do_devshell" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 22/30] dev-manual: common-tasks.rst: add reference to "do_listtasks" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 23/30] manuals: add references to the "do_bundle_initramfs" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 24/30] manuals: add references to the "do_rootfs" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 25/30] ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 26/30] manuals: add reference to the "do_kernel_configcheck" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 27/30] manuals: add references to the "do_kernel_configme" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 28/30] ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 29/30] migration-guides: add reference to the "do_shared_workdir" task michael.opdenacker
2022-09-23 17:52 ` [PATCH 30/30] ref-manual: tasks.rst: add reference to the "do_validate_branches" task michael.opdenacker
2022-09-26 14:00 ` [docs] [PATCH 00/30] manuals: add missing references to tasks Quentin Schulz
2022-10-05 18:15   ` Michael Opdenacker
     [not found] ` <20220923175219.6652-3-michael.opdenacker@bootlin.com>
2022-09-26 14:04   ` [docs] [PATCH 02/30] manuals: add reference to the "do_install" task Quentin Schulz
2022-10-05 18:06     ` Michael Opdenacker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220923175219.6652-5-michael.opdenacker@bootlin.com \
    --to=michael.opdenacker@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox