[04/30] manuals: add reference to "do_configure" task

Message ID	20220923175219.6652-5-michael.opdenacker@bootlin.com
State	New
Headers	show Return-Path: <michael.opdenacker@bootlin.com> ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 749D260005; Fri, 23 Sep 2022 17:52:48 +0000 (UTC) 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 Message-Id: <20220923175219.6652-5-michael.opdenacker@bootlin.com> In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	manuals: add missing references to tasks \| expand [00/30] manuals: add missing references to tasks [01/30] manuals: add references to the "do_fetch" task [03/30] manuals: add references to the "do_build" task [04/30] manuals: add reference to "do_configure" task [05/30] manuals: add reference to the "do_compile" task [06/30] manuals: add references to the "do_deploy" task [07/30] manuals: add references to the "do_image" task [08/30] manuals: add references to the "do_package" task [09/30] manuals: add references to the "do_package_qa" task [10/30] overview-manual: concepts.rst: add reference to "do_packagedata" task [11/30] manuals: add references to the "do_patch" task [12/30] manuals: add references to "do_package_write_*" tasks [13/30] ref-manual: variables.rst: add reference to "do_populate_lic" task [14/30] manuals: add reference to the "do_populate_sdk" task [15/30] overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task [16/30] manuals: add references to "do_populate_sysroot" task [17/30] manuals: add references to the "do_unpack" task [18/30] dev-manual: common-tasks.rst: add reference to "do_clean" task [19/30] manuals: add references to the "do_cleanall" task [20/30] ref-manual: tasks.rst: add references to the "do_cleansstate" task [21/30] manuals: add references to the "do_devshell" task [22/30] dev-manual: common-tasks.rst: add reference to "do_listtasks" task [23/30] manuals: add references to the "do_bundle_initramfs" task [24/30] manuals: add references to the "do_rootfs" task [25/30] ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task [26/30] manuals: add reference to the "do_kernel_configcheck" task [27/30] manuals: add references to the "do_kernel_configme" task [28/30] ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task [29/30] migration-guides: add reference to the "do_shared_workdir" task [30/30] ref-manual: tasks.rst: add reference to the "do_validate_branches" task

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>`\ ``]``

[04/30] manuals: add reference to "do_configure" task

Commit Message

Comments

Patch