From patchwork Fri Sep 23 17:51:50 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13169 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 627EAC6FA82 for ; Fri, 23 Sep 2022 17:52:39 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web10.583.1663955553176757560 for ; Fri, 23 Sep 2022 10:52:33 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=MCnIAqEo; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 704FD2000A; Fri, 23 Sep 2022 17:52:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955550; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=AKT+Gmfqtm4M7F3T6jOLXBDFbLRYRsbbmpo4ErjZy/4=; b=MCnIAqEozA54eKlz3/bAcq9wEGaOz+6W8goFsx/vgUrgbk5CRUkIAmFp6zK9fgbg5MkBkz wEtns8j69vnw5moSSDdEEQ81ZYGT9QdkPLm7aNosvK9UOWqKr3Loagbgc5UAUiveb4VYP0 qiQvzdKTIdbrYO3LKXJ7Dgg32GfoBQV00ih8Nj9Nu56qnZuDV/X+i97AjLdWuVE2FKgkqs IDk/qTQwhpNCjXjTSArEoK3YOyCuiqCNXPlzTc2il43BuQe4XFlf8RqTIoJDgVqdW2i8w4 6ae5rbCNMikgByyFLjY083FEZBKYOtiHZayvaHpwP+MYYqSq/sQQjFowm+t/uQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 01/30] manuals: add references to the "do_fetch" task Date: Fri, 23 Sep 2022 19:51:50 +0200 Message-Id: <20220923175219.6652-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:52:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3216 From: Michael Opdenacker [YOCTO #14508] Signed-off-by: Michael Opdenacker Reported-by: Quentin Schulz --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/migration-guides/migration-3.2.rst | 2 +- documentation/migration-guides/migration-4.0.rst | 4 ++-- documentation/overview-manual/concepts.rst | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 559709d6f3..3b25c9f950 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9633,7 +9633,7 @@ Running Specific Tasks ---------------------- Any given recipe consists of a set of tasks. The standard BitBake -behavior in most cases is: ``do_fetch``, ``do_unpack``, ``do_patch``, +behavior in most cases is: :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, ``do_configure``, ``do_compile``, ``do_install``, ``do_package``, ``do_package_write_*``, and ``do_build``. The default task is ``do_build`` and any tasks on which it depends build first. Some tasks, diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index 92b7f91f2c..71778f3e26 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst @@ -191,7 +191,7 @@ Globbing no longer supported in ``file://`` entries in ``SRC_URI`` Globbing (``*`` and ``?`` wildcards) in ``file://`` URLs within :term:`SRC_URI` did not properly support file checksums, thus changes to the source files -would not always change the do_fetch task checksum, and consequently would +would not always change the :ref:`ref-tasks-fetch` task checksum, and consequently would not ensure that the changed files would be incorporated in subsequent builds. Unfortunately it is not practical to make globbing work generically here, so diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index 79e53f89ac..ce3212a464 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst @@ -93,8 +93,8 @@ Fetching changes do_mytask[network] = "1" - This is allowed by default from ``do_fetch`` but not from any of our other standard - tasks. Recipes shouldn't be accessing the network outside of ``do_fetch`` as it + This is allowed by default from :ref:`ref-tasks-fetch` but not from any of our other standard + tasks. Recipes shouldn't be accessing the network outside of :ref:`ref-tasks-fetch` as it usually undermines fetcher source mirroring, image and licence manifests, software auditing and supply chain security. diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 8e0303f0e0..fa060ce0de 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1208,7 +1208,7 @@ end result. 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 ``do_fetch``, ``do_unpack``, ``do_patch``, +to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, ``do_patch``, ``do_configure``, ``do_compile``, and ``do_install`` tasks. However, if ``do_package`` needs to be run, BitBake needs to run those other tasks. From patchwork Fri Sep 23 17:51:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13170 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62189C04A95 for ; Fri, 23 Sep 2022 17:52:49 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web08.570.1663955568323015832 for ; Fri, 23 Sep 2022 10:52:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=bw5fk+PS; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id F350A40004; Fri, 23 Sep 2022 17:52:44 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955565; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=qhR3BxC1Q2f54EJ94DshHZbXhpARGoD0SVPkcyl7KYA=; b=bw5fk+PSsIZSzqWWzUx6GslvNYYmkF2fuuy3PWjUa9WQtUJCGmS2AMxXTMRgWM9FnZUPXO c4wvRJGsTP7ltQ9J12GuHYyQlXRP4LuqUwxw2XHfSylckLEfE9s1hUwL4/wFdg8ioodlEM 2hK+z6EohsGBWd5pTwfRduEqIs3s6IFVZE663Qv2smpI8bhRmM/909hmso/o0pJwsbSAta zZQVCvfXABCqX/hshmGx+bI5rkLT0IP4IWigiU1DRdrY6z+cvgG9NVvUk2lcTcw4USHdJ3 6lbXtojbyBHbOswn+dgZvr9m/hgaQD4sRAihoage9iHif4Y3DESkrj1NwblX0Q== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 03/30] manuals: add references to the "do_build" task Date: Fri, 23 Sep 2022 19:51:52 +0200 Message-Id: <20220923175219.6652-4-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:52:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3218 From: Michael Opdenacker [YOCTO #14508] Signed-off-by: Michael Opdenacker Reported-by: Quentin Schulz --- documentation/dev-manual/common-tasks.rst | 4 ++-- documentation/migration-guides/migration-3.4.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 09304d4b6a..7b20234991 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9635,8 +9635,8 @@ 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``, -``do_package_write_*``, and ``do_build``. The default task is -``do_build`` and any tasks on which it depends build first. Some tasks, +``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 wish to run a task that is not part of the default build chain, you can use the ``-c`` option in BitBake. Here is an example:: diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index bc2c75d42e..bf0887a8bd 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst @@ -206,7 +206,7 @@ Package/recipe splitting Image / SDK generation changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Recursive dependencies on the ``do_build`` task are now disabled when +- Recursive dependencies on the :ref:`ref-tasks-build` task are now disabled when building SDKs. These are generally not needed; in the unlikely event that you do encounter problems then it will probably be as a result of missing explicit dependencies that need to be added. From patchwork Fri Sep 23 17:51:53 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13171 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 79654C07E9D for ; Fri, 23 Sep 2022 17:52:59 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web09.556.1663955574824399879 for ; Fri, 23 Sep 2022 10:52:55 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=J3hfgegb; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 749D260005; Fri, 23 Sep 2022 17:52:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955573; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=61DB0R5Qeg02NRpbbfUenzyiA9T5dBxMuXzF5JWRWmw=; b=J3hfgegbIqMBBKrKrJwSe7MAjSDp9NbXZHCCBim/U4td3op+9rCcP9ldhLEJIOot9vQdRk 6YGux7gD4t+uANyw8iwG3KIBIG/JxjAtHB81bKa49nSiV7XonS06GUL38O/cHp/86cLDKg LQCxNNRUqa9c2Bx3nuY2DuU28QDEpSo+U6mZaMA9FKaws/fWg56So3OCFre6LrNYJhvU6f 78v6kJO+UflaswohQuh4to5cKmLrFq7TKFZlyLBrT34xk69QKfjSxHpLYBi5leTVVx0kdN ZINqox6AhxXyU3pydkkCnnFc+16/b6tdSfCg8Z0SNc8xx9SLHG2umb88s2v/EA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz 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> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:52:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3219 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- 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 `\ ``]`` 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 ` 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 ` 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* ` 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 `\ ``]`` From patchwork Fri Sep 23 17:51:54 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13173 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62977C6FA82 for ; Fri, 23 Sep 2022 17:53:09 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web12.529.1663955581166002447 for ; Fri, 23 Sep 2022 10:53:01 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=dEPSfBZo; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 5C8381BF206; Fri, 23 Sep 2022 17:52:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955579; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=wffBHG4EeAm5XJvvuJfLSr5DLY2QCUL6B/XGpMexoGI=; b=dEPSfBZoYtU5P7Uoh6c9ATnYDvaT8mI+SBDOuT0T7YOxNhDVl+EkuxBVXCFW3cEkDxvctQ ZZ+mkjAYjyu8UvH8Dbfaz/SQs15TibjU3LE/aSQza3Jifmny8Ca7uzx8X9Zf67Qm/iatYo EGTej7OuIr4JM2yWnmKfhvTH+mzykcnj7wf/DerP/k3+0+64RSIsPK/wFOsi2YfjcmEquW 8t9NU++T9u714pwd87g0W3QwaXKtYYFia7A4oYKbSCkJNLSZ+wqMuFoys8aLNhL/E7wJ36 M4RzXoqQ39zIaTM2DWtn1xldljXafbIuduEjwWeF3rh3UdjEF2mAY8pMcycZDA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 05/30] manuals: add reference to the "do_compile" task Date: Fri, 23 Sep 2022 19:51:54 +0200 Message-Id: <20220923175219.6652-6-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:09 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3220 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 16 ++++++++-------- documentation/overview-manual/concepts.rst | 2 +- documentation/ref-manual/classes.rst | 2 +- documentation/ref-manual/tasks.rst | 2 +- documentation/ref-manual/variables.rst | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 61755dd06e..0b512601e5 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -1826,8 +1826,8 @@ out-of-tree modules. Your recipe will also need the following:: Compilation ----------- -During a build, the ``do_compile`` task happens after source is fetched, -unpacked, and configured. If the recipe passes through ``do_compile`` +During a build, the :ref:`ref-tasks-compile` task happens after source is fetched, +unpacked, and configured. If the recipe passes through :ref:`ref-tasks-compile` successfully, nothing needs to be done. However, if the compile step fails, you need to diagnose the failure. @@ -2337,7 +2337,7 @@ Single .c File Package (Hello World!) Building an application from a single file that is stored locally (e.g. under ``files``) requires a recipe that has the file listed in the :term:`SRC_URI` variable. Additionally, you need to manually write the -``do_compile`` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the +:ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The :term:`S` variable defines the directory containing the source code, which is set to :term:`WORKDIR` in this case --- the directory BitBake uses for the build. @@ -2401,7 +2401,7 @@ Makefile-Based Package Applications that use GNU ``make`` also require a recipe that has the source archive listed in :term:`SRC_URI`. You do not need to add a -``do_compile`` step since by default BitBake starts the ``make`` command +:ref:`ref-tasks-compile` step since by default BitBake starts the ``make`` command to compile the application. If you need additional ``make`` options, you should store them in the :term:`EXTRA_OEMAKE` or @@ -2551,7 +2551,7 @@ doing the following: ``${``\ :term:`S`\ ``}``. If ``${S}`` might contain a Makefile, or if you inherit some class - that replaces :ref:`ref-tasks-configure` and ``do_compile`` with custom + that replaces :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` with custom versions, then you can use the ``[``\ :ref:`noexec `\ ``]`` flag to turn the tasks into no-ops, as follows:: @@ -3446,7 +3446,7 @@ Follow these general steps: you added to the patch. 6. *Test Your Changes:* Once you have modified the source code, the - easiest way to test your changes is by calling the ``do_compile`` + easiest way to test your changes is by calling the :ref:`ref-tasks-compile` task as shown in the following example:: $ bitbake -c compile -f package @@ -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``, -:ref:`ref-tasks-configure`, ``do_compile``, :ref:`ref-tasks-install`, ``do_package``, +:ref:`ref-tasks-configure`, :ref:`ref-tasks-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 @@ -9677,7 +9677,7 @@ The following example shows one way you can use the ``-f`` option:: This sequence first builds and then recompiles ``matchbox-desktop``. The last command reruns all tasks (basically the packaging tasks) after the -compile. BitBake recognizes that the ``do_compile`` task was rerun and +compile. BitBake recognizes that the :ref:`ref-tasks-compile` task was rerun and therefore understands that the other tasks also need to be run again. Another, shorter way to rerun a task and all diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 858118beec..06220401bc 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``, -:ref:`ref-tasks-configure`, ``do_compile``, and :ref:`ref-tasks-install` tasks. However, if +:ref:`ref-tasks-configure`, :ref:`ref-tasks-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/classes.rst b/documentation/ref-manual/classes.rst index 6e37738850..076ebb31ae 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -2401,7 +2401,7 @@ uses these build systems, the recipe needs to inherit the ``setuptools3`` class. .. note:: - The ``setuptools3`` class ``do_compile()`` task now calls + The ``setuptools3`` class :ref:`ref-tasks-compile` task now calls ``setup.py bdist_wheel`` to build the ``wheel`` binary archive format (See `PEP-427 `__). diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 16715984ae..e5938ee236 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -36,7 +36,7 @@ directory set to ``${``\ :term:`B`\ ``}``. The default behavior of this task is to run the ``oe_runmake`` function if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. -If no such file is found, the ``do_compile`` task does nothing. +If no such file is found, the :ref:`ref-tasks-compile` task does nothing. .. _ref-tasks-compile_ptest_base: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index bc29b5a05b..8055f044d0 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -5603,7 +5603,7 @@ system and gives an overview of their function and contents. .. note:: If the software being built experiences dependency issues during - the ``do_compile`` task that result in race conditions, you can clear + the :ref:`ref-tasks-compile` task that result in race conditions, you can clear the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For information on addressing race conditions, see the ":ref:`dev-manual/common-tasks:debugging parallel make races`" From patchwork Fri Sep 23 17:51:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13172 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62823C07E9D for ; Fri, 23 Sep 2022 17:53:09 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web10.589.1663955585558332483 for ; Fri, 23 Sep 2022 10:53:06 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=feL1PDST; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 77971200007; Fri, 23 Sep 2022 17:53:01 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955584; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=kZDVw2H4UQM+7frqL23kb7Fq59RRZuGua5l/PJZ4tuY=; b=feL1PDSTUbhziyTPVJOzLvopeD1NF9pm/5LLpZdgvC4xxVRSAM8FRVUfs7oyTyFMQK3xHP 3EKm4xv/go8jopH7oqoAJAr26wU4721R5g+zfGupVmyj5pjCkNLir1PfmMzShjiHxYxLg4 fckYJDDiQcIBy/uIO65cRPQai2ZLL1aEGaUsc0Qdsv+qzxRt+I7+YQCuzHsCd/0eoCByRK uUq4zNHJ4n4qt5b2zf4luWDj90CVRi3uH9iefo3onXFDj3t48CEg+T9tPBu9zMkRZKfgsR 9xQAbrOYD6+TYGTBoicWxtE3weubFzkrf+AMdF/bYHN/hA+cYJL6WQxc21QW0A== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 06/30] manuals: add references to the "do_deploy" task Date: Fri, 23 Sep 2022 19:51:55 +0200 Message-Id: <20220923175219.6652-7-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:09 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3221 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- .../migration-guides/migration-3.2.rst | 4 ++-- documentation/overview-manual/concepts.rst | 18 +++++++++--------- documentation/ref-manual/tasks.rst | 8 ++++---- documentation/ref-manual/variables.rst | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index 8a8d19d605..4c0de7b0f6 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst @@ -207,9 +207,9 @@ files into a subdirectory and reference that instead. deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` ---------------------------------------------------------- -``do_deploy`` as implemented in the :ref:`deploy ` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. +:ref:`ref-tasks-deploy` as implemented in the :ref:`deploy ` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. -Most recipes and classes that inherit the :ref:`deploy ` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. +Most recipes and classes that inherit the :ref:`deploy ` class or interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. .. _migration-3.2-nativesdk-sdk-provides-dummy: diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 06220401bc..f3f8cbd95c 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1801,14 +1801,14 @@ from the :ref:`deploy ` class:: The following list explains the previous example: -- Adding "do_deploy" to ``SSTATETASKS`` adds some required +- Adding ``do_deploy`` to ``SSTATETASKS`` adds some required sstate-related processing, which is implemented in the :ref:`sstate ` class, to before and after the :ref:`ref-tasks-deploy` task. - The ``do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"`` declares that - ``do_deploy`` places its output in ``${DEPLOYDIR}`` when run normally + :ref:`ref-tasks-deploy` places its output in ``${DEPLOYDIR}`` when run normally (i.e. when not using the sstate cache). This output becomes the input to the shared state cache. @@ -1818,15 +1818,15 @@ The following list explains the previous example: .. note:: - If ``do_deploy`` is not already in the shared state cache or if its input + If :ref:`ref-tasks-deploy` is not already in the shared state cache or if its input checksum (signature) has changed from when the output was cached, the task runs to populate the shared state cache, after which the contents of the shared state cache is copied to ${:term:`DEPLOY_DIR_IMAGE`}. If - ``do_deploy`` is in the shared state cache and its signature indicates + :ref:`ref-tasks-deploy` is in the shared state cache and its signature indicates that the cached output is still valid (i.e. if no relevant task inputs have changed), then the contents of the shared state cache copies directly to ${:term:`DEPLOY_DIR_IMAGE`} by the ``do_deploy_setscene`` task - instead, skipping the ``do_deploy`` task. + instead, skipping the :ref:`ref-tasks-deploy` task. - The following task definition is glue logic needed to make the previous settings effective:: @@ -1836,16 +1836,16 @@ The following list explains the previous example: } addtask do_deploy_setscene - ``sstate_setscene()`` takes the flags above as input and accelerates the ``do_deploy`` task + ``sstate_setscene()`` takes the flags above as input and accelerates the :ref:`ref-tasks-deploy` task through the shared state cache if possible. If the task was accelerated, ``sstate_setscene()`` returns True. Otherwise, it - returns False, and the normal ``do_deploy`` task runs. For more + returns False, and the normal :ref:`ref-tasks-deploy` task runs. For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" section in the BitBake User Manual. - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates - ``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and - also sets the current working directory of ``do_deploy`` to ``${B}``. + ``${DEPLOYDIR}`` and ``${B}`` before the :ref:`ref-tasks-deploy` task runs, and + also sets the current working directory of :ref:`ref-tasks-deploy` to ``${B}``. For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" section in the BitBake User Manual. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index e5938ee236..5efe64b35d 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -81,7 +81,7 @@ Recipes implementing this task should inherit the :ref:`deploy ` class and should write the output to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be confused with ``${DEPLOY_DIR}``. The :ref:`deploy ` class sets up -``do_deploy`` as a shared state (sstate) task that can be accelerated +:ref:`ref-tasks-deploy` as a shared state (sstate) task that can be accelerated through sstate use. The sstate mechanism takes care of copying the output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. @@ -90,14 +90,14 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes the sstate mechanism to malfunction. -The ``do_deploy`` task is not added as a task by default and +The :ref:`ref-tasks-deploy` task is not added as a task by default and consequently needs to be added manually. If you want the task to run after :ref:`ref-tasks-compile`, you can add it by doing the following:: addtask deploy after do_compile -Adding ``do_deploy`` after other tasks works the same way. +Adding :ref:`ref-tasks-deploy` after other tasks works the same way. .. note:: @@ -110,7 +110,7 @@ Adding ``do_deploy`` after other tasks works the same way. See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" section in the BitBake User Manual for more information. -If the ``do_deploy`` task re-executes, any previous output is removed +If the :ref:`ref-tasks-deploy` task re-executes, any previous output is removed (i.e. "cleaned"). .. _ref-tasks-fetch: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 8055f044d0..8fac7f77ad 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -6712,7 +6712,7 @@ system and gives an overview of their function and contents. - do_populate_lic - do_package_qa - do_populate_sysroot - - do_deploy + - :ref:`ref-tasks-deploy` Despite the default value of "" for the :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added From patchwork Fri Sep 23 17:51:56 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13174 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 63566C07E9D for ; Fri, 23 Sep 2022 17:53:19 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web09.560.1663955591033855131 for ; Fri, 23 Sep 2022 10:53:11 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=VphprWtN; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3803C200002; Fri, 23 Sep 2022 17:53:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955589; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ipgIg6BdsVqk+sn2X5BvtkFUbRe9J2+zM3KwZGFESuo=; b=VphprWtNC5aVtk76xESQwBaHmpTBtDk8KnF5kr5N5a9p6KNqZ5652bDU9riSkAu3jJthw5 qXrWS0CBxLU7XbNNdmVTG8aNe7qFPtCTCDJp+nsKLyHFrGf4Wf+fKeJxzDvUDdtwwyLPek fYXLQbEC39VNZ9Fic6OsSpOQ5Rgk0PokCrYCqCehsTxcgDM/fk4WBG5GPk1/eL+ggBQrZu AK+FwQDQCYD2UWgtB051F2SvkdYasedyV7++HMuhiJPlZWUhtZVefmFlDUCNGQXa7SQG3b c7NRqV8gxtgku//cYM49y77RbyDywcEJ10ZrtCJOpjZh1c6ZT1UXxpFAcCH5SA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 07/30] manuals: add references to the "do_image" task Date: Fri, 23 Sep 2022 19:51:56 +0200 Message-Id: <20220923175219.6652-8-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:19 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3222 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/overview-manual/concepts.rst | 4 ++-- documentation/ref-manual/tasks.rst | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 0b512601e5..22d1634f1b 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3853,7 +3853,7 @@ to be added to the recipe that builds the ``core-image-sato`` image:: do_image[mcdepends] = "mc:x86:arm:core-image-minimal:do_rootfs" In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The -task on which the ``do_image`` task in the recipe depends is the +task on which the :ref:`ref-tasks-image` task in the recipe depends is the ``do_rootfs`` task from the ``core-image-minimal`` recipe associated with the "arm" multiconfig. diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index f3f8cbd95c..3bb728f990 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1036,7 +1036,7 @@ the variable. This variable specifies a list of functions to call before the build system creates the final image output files. -The build system dynamically creates ``do_image_*`` tasks as needed, +The build system dynamically creates :ref:`do_image_* ` tasks as needed, based on the image types specified in the :term:`IMAGE_FSTYPES` variable. The process turns everything into an image file or a set of image files @@ -2162,7 +2162,7 @@ operations that are normally reserved for the root user (e.g. :ref:`ref-tasks-install`, :ref:`do_package_write* `, :ref:`ref-tasks-rootfs`, and -:ref:`do_image* `). For example, +:ref:`do_image_* `). For example, the :ref:`ref-tasks-install` task benefits from being able to set the UID and GID of installed files to arbitrary values. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 5efe64b35d..63af2730e7 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -128,15 +128,15 @@ module. ``do_image`` ------------ -Starts the image generation process. The ``do_image`` task runs after +Starts the image generation process. The :ref:`ref-tasks-image` task runs after the OpenEmbedded build system has run the :ref:`ref-tasks-rootfs` task during which packages are identified for installation into the image and the root filesystem is created, complete with post-processing. -The ``do_image`` task performs pre-processing on the image through the +The :ref:`ref-tasks-image` task performs pre-processing on the image through the :term:`IMAGE_PREPROCESS_COMMAND` and -dynamically generates supporting ``do_image_*`` tasks as needed. +dynamically generates supporting :ref:`do_image_* ` tasks as needed. For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`" section in the Yocto Project Overview and Concepts Manual. @@ -149,7 +149,7 @@ section in the Yocto Project Overview and Concepts Manual. Completes the image generation process. The ``do_image_complete`` task runs after the OpenEmbedded build system has run the :ref:`ref-tasks-image` task during which image -pre-processing occurs and through dynamically generated ``do_image_*`` +pre-processing occurs and through dynamically generated :ref:`do_image_* ` tasks the image is constructed. The ``do_image_complete`` task performs post-processing on the image From patchwork Fri Sep 23 17:51:57 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13175 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 635A6C6FA82 for ; Fri, 23 Sep 2022 17:53:19 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web11.581.1663955594658802388 for ; Fri, 23 Sep 2022 10:53:15 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=OenAM6M1; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 4A5C7200002; Fri, 23 Sep 2022 17:53:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955593; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=X1bwRVVQ5FO5W6abRpXn1hngdcreJB8O0nE65MOTy+g=; b=OenAM6M1Do8EzwdqYMF3ZUN3s6wgvYwLHfLZ4PRERCZMleM/vGE3NJQJc+TX1Gc/6nhh5t gBP9ev7qLZOqyttpJV9AirRkD56SIESaXy1n3fz3cb459k6Dpiqg6tMQBMt+mNclMRULRF U8biynkVxWlLjM1UNpS+0t9WxC1SOFw4lT9o4mTXKYEK8F3Vo+ryMRKeG4xkSX06mYN/Qw ynwuBWTXEdSFQlA1orSp+zErd7LN0nT/i1cnrhVVGVEqBUh9xjRTdH3KhnQs/vZTm5S86w 8slSD2LK9qfTNTnjTcymruzKdylC3jOim29SxeCt5z/yJHdkwoz3gRi+cxwyYg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 08/30] manuals: add references to the "do_package" task Date: Fri, 23 Sep 2022 19:51:57 +0200 Message-Id: <20220923175219.6652-9-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:19 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3223 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 6 +++--- documentation/overview-manual/concepts.rst | 12 ++++++------ documentation/ref-manual/structure.rst | 2 +- documentation/ref-manual/tasks.rst | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 22d1634f1b..74b050f600 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -2028,10 +2028,10 @@ Successful packaging is a combination of automated processes performed by the OpenEmbedded build system and some specific steps you need to take. The following list describes the process: -- *Splitting Files*: The ``do_package`` task splits the files produced +- *Splitting Files*: The :ref:`ref-tasks-package` task splits the files produced by the recipe into logical components. Even software that produces a single binary might still have debug symbols, documentation, and - other logical components that should be split out. The ``do_package`` + other logical components that should be split out. The :ref:`ref-tasks-package` task ensures that files are split up and packaged correctly. - *Running QA Checks*: The @@ -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``, -:ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, ``do_package``, +: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:`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/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 3bb728f990..bbe0ec345b 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -905,7 +905,7 @@ the analysis and package splitting process use several areas: individual packages. - :term:`PKGDESTWORK`: A - temporary work area (i.e. ``pkgdata``) used by the ``do_package`` + temporary work area (i.e. ``pkgdata``) used by the :ref:`ref-tasks-package` task to save package metadata. - :term:`PKGDEST`: The parent @@ -1210,13 +1210,13 @@ 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``, :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if -``do_package`` needs to be run, BitBake needs to run those other tasks. +:ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks. 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 -from sstate, BitBake does not need the ``do_package`` task data. +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 is the "setscene" stage. During this stage, BitBake first checks the @@ -1854,7 +1854,7 @@ The following list explains the previous example: In cases where ``sstate-inputdirs`` and ``sstate-outputdirs`` would be the same, you can use ``sstate-plaindirs``. For example, to preserve the - ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the ``do_package`` + ${:term:`PKGD`} and ${:term:`PKGDEST`} output from the :ref:`ref-tasks-package` task, use the following:: do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" @@ -2101,7 +2101,7 @@ dependencies, you must manually declare the dependencies. :term:`PRIVATE_LIBS` inside the package's recipe. -- ``pcdeps``: During the ``do_package`` task of each recipe, all +- ``pcdeps``: During the :ref:`ref-tasks-package` task of each recipe, all pkg-config modules (``*.pc`` files) installed by the recipe are located. For each module, the package that contains the module is registered as providing the module. The resulting module-to-package @@ -2147,7 +2147,7 @@ dependencies, you must manually declare the dependencies. :term:`ALLOW_EMPTY` variable for more information. -The ``do_package`` task depends on the ``do_packagedata`` task of each +The :ref:`ref-tasks-package` task depends on the ``do_packagedata`` task of each recipe in :term:`DEPENDS` through use of a ``[``\ :ref:`deptask `\ ``]`` declaration, which guarantees that the required diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 429f81e14c..533745b370 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -630,7 +630,7 @@ Here are key subdirectories within each recipe work directory: split into individual packages. - ``${WORKDIR}/packages-split``: Contains the output of the - ``do_package`` task after the output has been split into individual + :ref:`ref-tasks-package` task after the output has been split into individual packages. There are subdirectories for each individual package created by the recipe. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 63af2730e7..1bb8bc1918 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -212,7 +212,7 @@ based on available packages and files. This task makes use of the :term:`PACKAGES` and :term:`FILES` variables. -The ``do_package`` task, in conjunction with the +The :ref:`ref-tasks-package` task, in conjunction with the :ref:`ref-tasks-packagedata` task, also saves some important package metadata. For additional information, see the :term:`PKGDESTWORK` variable and the From patchwork Fri Sep 23 17:51:58 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13178 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 627A6C07E9D for ; Fri, 23 Sep 2022 17:53:29 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web12.534.1663955601200039427 for ; Fri, 23 Sep 2022 10:53:21 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=cYIsyqJp; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 7DE8EFF803; Fri, 23 Sep 2022 17:53:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955599; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=WGnMCrfzyXsQ9Wbq0kOpHVb46fDTcM+hyhhlfmb47IA=; b=cYIsyqJp1OWf3GMhrvYEYDs4GAd1Ofh8m3GvfzXevE4wYXG0A335cPoavzFJeb14jm6Hss VBGScJXarelq/WmJsNNe2p/EBCB/QMfTlPg7vF18VACe0BG3utTKj2tr9ZbY4U9xcK5YRF je0EMb2Y2ayA20j//3mmDGxpTjZvFe4TwwjGhjJYJ6BWFJzMbQ50eh+IV1RBIDQ/np3JO4 EtF35ukta6sZQXHZrq/ZmlkYFXST+lY0pY8y9OMtXPxJ28foiA9KeutXzuocIzlWKafo2a SiBs58+s4Rnw8k7h9TOW8iuVnEt7BLQCi4ea+sA3LmJT9vMfLe4Acenfwzp/rw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 09/30] manuals: add references to the "do_package_qa" task Date: Fri, 23 Sep 2022 19:51:58 +0200 Message-Id: <20220923175219.6652-10-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3224 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/migration-guides/migration-1.7.rst | 2 +- documentation/migration-guides/migration-3.1.rst | 2 +- documentation/ref-manual/variables.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index 8213ab58d9..7b179f2aa1 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst @@ -165,7 +165,7 @@ The following changes have occurred to the QA check process: more parallel execution. This change is unlikely to be an issue except for highly customized recipes that disable packaging tasks themselves by marking them as ``noexec``. For those packages, you - will need to disable the ``do_package_qa`` task as well. + will need to disable the :ref:`ref-tasks-package_qa` task as well. - Files being overwritten during the :ref:`ref-tasks-populate_sysroot` task now diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index cc788efeba..a6106eefae 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst @@ -234,7 +234,7 @@ Packaging changes Additional warnings ------------------- -Warnings will now be shown at ``do_package_qa`` time in the following +Warnings will now be shown at :ref:`ref-tasks-package_qa` time in the following circumstances: - A recipe installs ``.desktop`` files containing ``MimeType`` keys but diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 8fac7f77ad..45d058a281 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -6710,7 +6710,7 @@ system and gives an overview of their function and contents. the following tasks are added: - do_populate_lic - - do_package_qa + - :ref:`ref-tasks-package_qa` - do_populate_sysroot - :ref:`ref-tasks-deploy` From patchwork Fri Sep 23 17:51:59 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13177 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5DF1CC04A95 for ; Fri, 23 Sep 2022 17:53:29 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web08.577.1663955604467171370 for ; Fri, 23 Sep 2022 10:53:24 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=bFOXvkTX; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3FA67200003; Fri, 23 Sep 2022 17:53:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955603; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VlYaOmGJ8Cc5ujdrmLRoQHy1O7X7Oiv0OE5rqbIez+I=; b=bFOXvkTXqY+YLz8UTZ4PMznQh5d48zgZCC1dBSq/22q8cjcGQZJEbQA+E6f911wBf/B9N/ UqfbfzuY5bXLjIZMD9BYte+Tpzja+qEDM5OOgwyht7ziENbWk7EaZcWHBVPZO9fMBgx9CL /3tF2RJteGf4Za7Jm9LIh2xn9X1098pleaqGvhg9idHQgp1L9+iFwA+WgIADTD5f2FTJEN s6gyj3mP1e7N9nTuL+UTjLTHcxvS8G6rGN/Ok6jOX/gjw3XN5MuMW1Tgd+sjscrepmvpZa FoqkLa+24IM4zrRBAXBwolQhjDDw6PB8mYOFgLq40EkWx6TmssqcNGXktTuC+g== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 10/30] overview-manual: concepts.rst: add reference to "do_packagedata" task Date: Fri, 23 Sep 2022 19:51:59 +0200 Message-Id: <20220923175219.6652-11-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3225 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/overview-manual/concepts.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index bbe0ec345b..36498ba1e1 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -892,7 +892,7 @@ following as well as other items: splitting out debugging symbols, looking at shared library dependencies between packages, and looking at package relationships. -The ``do_packagedata`` task creates package metadata based on the +The :ref:`ref-tasks-packagedata` task creates package metadata based on the analysis such that the build system can generate the final packages. The :ref:`ref-tasks-populate_sysroot` task stages (copies) a subset of the files installed by the @@ -2106,7 +2106,7 @@ dependencies, you must manually declare the dependencies. located. For each module, the package that contains the module is registered as providing the module. The resulting module-to-package mapping is saved globally in :term:`PKGDATA_DIR` by the - ``do_packagedata`` task. + :ref:`ref-tasks-packagedata` task. Simultaneously, all pkg-config modules installed by the recipe are inspected to see what other pkg-config modules they depend on. A @@ -2147,7 +2147,7 @@ dependencies, you must manually declare the dependencies. :term:`ALLOW_EMPTY` variable for more information. -The :ref:`ref-tasks-package` task depends on the ``do_packagedata`` task of each +The :ref:`ref-tasks-package` task depends on the :ref:`ref-tasks-packagedata` task of each recipe in :term:`DEPENDS` through use of a ``[``\ :ref:`deptask `\ ``]`` declaration, which guarantees that the required From patchwork Fri Sep 23 17:52:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13176 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 64717C6FA83 for ; Fri, 23 Sep 2022 17:53:29 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web08.578.1663955607245342557 for ; Fri, 23 Sep 2022 10:53:27 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Q+3fV6zA; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 7773960003; Fri, 23 Sep 2022 17:53:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955605; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5MBJCc8u+IdhLqriVqEWDNn7p3TZyxeD4dToy8eDPow=; b=Q+3fV6zAJecv+hmyW5Xph3170RHrRb5dUfRFiKfAjdSzv9PeetfbPFFbhaEAVtAry1WsDG Ph7s37UcQ/A+BXy9a2/F7nKB5GieUVM1TFnpFGozyfdvO1tH8tpUgahhU3dktovaYtBPvz 6B//VxXNNmEE7nLiKmWa6T9L9QEmGRbwEVKdz+LH/w/xQir1sGdJEnby0upAlSE8db256V CzsBigZC0JKrek9rDfCoJ8T8Y6mbciiuKMMp+UjOYuk4f1yFAiQvBdmhqpshsHPPtR3/DB xigZCvHaH9J8/8SQOmDX/dtVQr2JUH5UL2bHIWMybA0/wFxRrx7XoUgEn4NlmA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 11/30] manuals: add references to the "do_patch" task Date: Fri, 23 Sep 2022 19:52:00 +0200 Message-Id: <20220923175219.6652-12-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:29 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3226 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/migration-guides/migration-1.3.rst | 2 +- documentation/overview-manual/concepts.rst | 2 +- documentation/ref-manual/qa-checks.rst | 2 +- documentation/ref-manual/tasks.rst | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 74b050f600..947e10560a 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9633,7 +9633,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``, +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:`ref-tasks-build` and any tasks on which it depends build first. Some tasks, diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 6a1755d1dc..09fc39d3ca 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst @@ -62,7 +62,7 @@ Previously, an inconsistent mix of spaces and tabs existed, which made extending these functions using ``_append`` or ``_prepend`` complicated given that Python treats whitespace as syntactically significant. If you are defining or extending any Python functions (e.g. -``populate_packages``, ``do_unpack``, ``do_patch`` and so forth) in +``populate_packages``, ``do_unpack``, :ref:`ref-tasks-patch` and so forth) in custom recipes or classes, you need to ensure you are using consistent four-space indentation. diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 36498ba1e1..f1457522da 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1208,7 +1208,7 @@ end result. 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``, +to run any of the :ref:`ref-tasks-fetch`, ``do_unpack``, :ref:`ref-tasks-patch`, :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if :ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks. diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index ff8916aedf..9455bec3fd 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst @@ -677,7 +677,7 @@ Errors and Warnings - ``Fuzz detected: [patch-fuzz]`` - This check looks for evidence of "fuzz" when applying patches within the ``do_patch`` + This check looks for evidence of "fuzz" when applying patches within the :ref:`ref-tasks-patch` task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context lines in order to apply the patch. Consider this example: diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 1bb8bc1918..f0129c1f72 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -327,7 +327,7 @@ file as a patch file:: " Conversely, if you have a file whose file type is ``.patch`` or ``.diff`` -and you want to exclude it so that the ``do_patch`` task does not apply +and you want to exclude it so that the :ref:`ref-tasks-patch` task does not apply it during the patch phase, you can use the "apply=no" parameter with the :term:`SRC_URI` statement:: From patchwork Fri Sep 23 17:52:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13183 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 634D0C6FA82 for ; Fri, 23 Sep 2022 17:53:39 +0000 (UTC) Received: from relay11.mail.gandi.net (relay11.mail.gandi.net [217.70.178.231]) by mx.groups.io with SMTP id smtpd.web12.536.1663955609688181514 for ; Fri, 23 Sep 2022 10:53:30 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=ntxScz6E; spf=pass (domain: bootlin.com, ip: 217.70.178.231, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 43E31100004; Fri, 23 Sep 2022 17:53:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955607; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=uNC3DeVaM08bEKSXv2zXCnY5EGxrhHKYKBwwbUQfS94=; b=ntxScz6E1c1m3BJCRnxnDwlGUHDSYkobFBN+HrNVqZ23E91dB12fvizcT/bbP8aj4KbcPR 2ovHQBEKwQEGUSr7WyG1os6Rgr4Fy3vbk4PNVxeWjBg5OJPXu6N6B89ruaNcGaClqhUX+G vFsew7QJZJ9OfD1/4wRdtaYCx65JYyANQbnC1yl/hYQpWZF4P4QiwPofJe4WSemrFTodMz 2HL9MbuT9MrpqsCEtKGxI0+gEj++4kC5tz6tKWUHdQxVJPZlczAvyp/KBgYeKrCl0LCATb d7cPn+ehU2dammWR8FYbnQQEhHdd0JpnpyxK8A0opGlI67Jhr59NjTTWRczt7Q== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 12/30] manuals: add references to "do_package_write_*" tasks Date: Fri, 23 Sep 2022 19:52:01 +0200 Message-Id: <20220923175219.6652-13-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3227 From: Michael Opdenacker Using a reference to "do_package_write_deb", the first entry in the list. [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- 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 --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_* `, 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:`ref-tasks-package`, -``do_package_write_*``, +:ref:`do_package_write_* `, :ref:`ref-tasks-deploy`, :ref:`ref-tasks-packagedata`, and :ref:`ref-tasks-populate_sysroot`. @@ -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_* ` 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_* ` 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_* `, and :ref:`ref-tasks-rootfs`), run under :ref:`fakeroot `. 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_\* ` tasks. + :ref:`do_package_write_* ` 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_* ` task of the recipes that build ``bar`` and ``baz``. The names of the packages you list within :term:`RDEPENDS` must be the From patchwork Fri Sep 23 17:52:02 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13181 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6D13EC6FA86 for ; Fri, 23 Sep 2022 17:53:39 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web08.580.1663955611440910526 for ; Fri, 23 Sep 2022 10:53:31 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=FbVNcjOO; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 2820E40005; Fri, 23 Sep 2022 17:53:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955609; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=H1Y2MuFtzJTPox4ct3yzbXKmkoGkwlNxbUPHgGZTqtg=; b=FbVNcjOO/LUrpEIyZvCvtJNiB20o3pY504EiaXKKquY7oXgbHmBt+eJEx9rtSCTevHNpHZ RCpEfxJxrkAxt8wsPBnCu0VmUifpx0wZ+2/kgIQmyJC25LJi+bggTpo6+XOVrADZ4764HD PfA/0belFSOlh7g86N2wjVUpQFy3C9GjXzoT9IA0qqMkkqyPRhRiq7J6X3RjBWccM/dy5j vcgzVg6cvGoCjygrX/jOSwEXnCpcrNrR46gj+GZwrORdjcKYnjznQ2gq0+AZuR/1dNpYxS 1xmFhF1Sy6qolCYzjN5x65Jx/58d/JSlKVwsBnwth00iSw4roltFnjs8n8yn7g== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 13/30] ref-manual: variables.rst: add reference to "do_populate_lic" task Date: Fri, 23 Sep 2022 19:52:02 +0200 Message-Id: <20220923175219.6652-14-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3228 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/ref-manual/variables.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 272673d90b..e71c3b6b57 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -6709,7 +6709,7 @@ system and gives an overview of their function and contents. A list of shared state tasks added to the extensible SDK. By default, the following tasks are added: - - do_populate_lic + - :ref:`ref-tasks-populate_lic` - :ref:`ref-tasks-package_qa` - do_populate_sysroot - :ref:`ref-tasks-deploy` From patchwork Fri Sep 23 17:52:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13179 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6D172C6FA92 for ; Fri, 23 Sep 2022 17:53:39 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web08.581.1663955612547298699 for ; Fri, 23 Sep 2022 10:53:33 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Nxu/JFTj; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id E4AAF200006; Fri, 23 Sep 2022 17:53:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955611; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=KLreiqD6AzLG5eZB8VYQ2nJxHpbSAwjERcOnQHIal8I=; b=Nxu/JFTjdwKRbO26JJ3yUxU8v1lHZYNvE1V+a9yZcaaiYwHD6APsQXNmE5PYG23n2/zxSy 3AufHR5E/tirG1+pVJpLx0Lp+q7O384gstZ3UxZl4Ko7NoF3OpKQptZ6hpXS8n4o9igVjL Wh6/bzORhIYr7xidiMiVn27Gv6kx8dmj/yhmkmrr5ZxUf4I45Iy+tlKAK+oLVxnASdFQHi wUI58qHJdT0QlV+XjzX5fX2o0Kbj3nkgSuBZRY9S0uLCP2LV/wwWNV6rkVyiQw66Np8VGf /Ar2Ol9PvOxhPn90y6FWCwQlSAYkPd+lK5BfXm+SHT4zlswG0WCgrfaUb265Rw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 14/30] manuals: add reference to the "do_populate_sdk" task Date: Fri, 23 Sep 2022 19:52:03 +0200 Message-Id: <20220923175219.6652-15-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3229 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/migration-guides/release-notes-3.4.rst | 2 +- documentation/overview-manual/concepts.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 323e4df7ae..33525120c6 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst @@ -67,7 +67,7 @@ New Features / Enhancements in 3.4 - SDK-related enhancements: - - Enable do_populate_sdk with multilibs + - Enable :ref:`ref-tasks-populate_sdk` with multilibs - New ``SDKPATHINSTALL`` variable decouples default install path from built in path to avoid rebuilding nativesdk components on e.g. :term:`DISTRO_VERSION` changes - eSDK: Error if trying to generate an eSDK from a multiconfig - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index a477139996..1215e0ee94 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1085,7 +1085,7 @@ the extensible SDK (eSDK): For more information on the cross-development toolchain generation, see the ":ref:`overview-manual/concepts:cross-development toolchain generation`" section. For information on advantages gained when building a - cross-development toolchain using the do_populate_sdk task, see the + cross-development toolchain using the :ref:`ref-tasks-populate_sdk` task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. @@ -1100,7 +1100,7 @@ actually install. For information on the variables listed in the figure, see the ":ref:`overview-manual/concepts:application development sdk`" section. -The ``do_populate_sdk`` task helps create the standard SDK and handles +The :ref:`ref-tasks-populate_sdk` task helps create the standard SDK and handles two parts: a target part and a host part. The target part is the part built for the target hardware and includes libraries and headers. The host part is the part of the SDK that runs on the From patchwork Fri Sep 23 17:52:04 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13180 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 63F1FC6FA83 for ; Fri, 23 Sep 2022 17:53:39 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web11.587.1663955614226833949 for ; Fri, 23 Sep 2022 10:53:34 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Ozg+5fyj; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id AB8FC20005; Fri, 23 Sep 2022 17:53:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955612; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=KvxnVt+HuNOgtqaJDq8mP6RuG7mVWVsgOIq2Xt2CEsI=; b=Ozg+5fyj6Xnpz2ydak8/lcZMNOpX8imJLdBrsBKkEqj2oj3JavIilR+2D9M/btzskzFUwy 7sLh0wLrDQndhqOI3OOytquWMs7+2TCfNV0uKqSRm3W0+SZETqZaZBJPC7/78R2QpsU3zz EXm1ea66KeU8tcjNpp72ThvMNmuYieQVr2YaVrHqMGs0q2V5ArxqTF9wylAcZYSgJoKFFu hnQV9cY1dBHs1UfhCyclwWflQr/nrCI6v3RXJCB555/vh7QrGpDRRe/EOSrRU23JIWQps+ aoqldx3I8fGBFSbFKUB8qvuZq7QMU0JyMNCOUiSfR4J42KPRSMltePPyo7bVBA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 15/30] overview-manual: concepts.rst: add reference to "do_populate_sdk_ext" task Date: Fri, 23 Sep 2022 19:52:04 +0200 Message-Id: <20220923175219.6652-16-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3230 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/overview-manual/concepts.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 1215e0ee94..423f645740 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1106,7 +1106,7 @@ built for the target hardware and includes libraries and headers. The host part is the part of the SDK that runs on the :term:`SDKMACHINE`. -The ``do_populate_sdk_ext`` task helps create the extensible SDK and +The :ref:`ref-tasks-populate_sdk_ext` task helps create the extensible SDK and handles host and target parts differently than its counter part does for the standard SDK. For the extensible SDK, the task encapsulates the build system, which includes everything needed (host and target) for the From patchwork Fri Sep 23 17:52:05 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13182 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 630D2C04A95 for ; Fri, 23 Sep 2022 17:53:39 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web12.541.1663955616010336793 for ; Fri, 23 Sep 2022 10:53:36 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=QpUY4QiO; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3891B40005; Fri, 23 Sep 2022 17:53:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955614; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=k5mAUFF64S8r+RIpCSTnvTFaWl8UFrabBeGIbhvQCo8=; b=QpUY4QiOWhCLFCz3HDeUh9DRPGZtyQZQy1Bl9Nc6+fgFEJebX75pd7VBq5eLdPYmKD+JyI d1l074nD56CvFtWxmWmjgalgXUICtMefEifhJRA64JJB2Cl8fmE/bj3OC5zK//oj/kp6vs kglWtRf1fkUeFQsoFq/z5CmH45BGTXvcWTSe4c+f4MJwLILH2BZbIJmBBOP8dIg4SzpNeO oWQh1eiEH6qEGVfj70YGOPTtS+ikLeDkMbCUb5UiyX6bxXM5gbn6BKpOYnALaIVLRtFiUX 8ycS31qJzYgTvbw3EuiM3P7zjotsQvTNBXKJF7Z9xLWHnrHGfGnUaasdmdaN7A== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 16/30] manuals: add references to "do_populate_sysroot" task Date: Fri, 23 Sep 2022 19:52:05 +0200 Message-Id: <20220923175219.6652-17-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:39 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3231 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/ref-manual/classes.rst | 2 +- documentation/ref-manual/tasks.rst | 2 +- documentation/ref-manual/variables.rst | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index dbf7dad558..5332b21c4a 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -8481,7 +8481,7 @@ The following list shows the files produced for SDKs: information. - ``sstate-task-sizes.txt:`` A text file containing name-value pairs - with information about task group sizes (e.g. ``do_populate_sysroot`` + with information about task group sizes (e.g. :ref:`ref-tasks-populate_sysroot` tasks have a total size). The ``sstate-task-sizes.txt`` file exists only when an extensible SDK is created. diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 977dc34523..033284a46c 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -2527,7 +2527,7 @@ stages: want to share with other recipes that have dependencies on the originating recipe. Normally these dependencies are installed through the :ref:`ref-tasks-install` task into - ``${``\ :term:`D`\ ``}``. The ``do_populate_sysroot`` task + ``${``\ :term:`D`\ ``}``. The :ref:`ref-tasks-populate_sysroot` task copies a subset of these files into ``${SYSROOT_DESTDIR}``. This subset of files is controlled by the :term:`SYSROOT_DIRS`, diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index b099ce7a5c..bf3a038b1a 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -392,7 +392,7 @@ For information on what directories are copied by default, see the these variables inside your recipe if you need to make additional (or fewer) directories available to other recipes at build time. -The ``do_populate_sysroot`` task is a shared state (sstate) task, which +The :ref:`ref-tasks-populate_sysroot` task is a shared state (sstate) task, which means that the task can be accelerated through sstate use. Realize also that if the task is re-executed, any previous output is removed (i.e. "cleaned"). diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e71c3b6b57..79c64dc97a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -6711,7 +6711,7 @@ system and gives an overview of their function and contents. - :ref:`ref-tasks-populate_lic` - :ref:`ref-tasks-package_qa` - - do_populate_sysroot + - :ref:`ref-tasks-populate_sysroot` - :ref:`ref-tasks-deploy` Despite the default value of "" for the @@ -7382,7 +7382,7 @@ system and gives an overview of their function and contents. For most recipes, this sysroot is the one in which that recipe's :ref:`ref-tasks-populate_sysroot` task copies files. Exceptions include ``-native`` recipes, where the - ``do_populate_sysroot`` task instead uses + :ref:`ref-tasks-populate_sysroot` task instead uses :term:`STAGING_DIR_NATIVE`. Depending on the type of recipe and the build target, :term:`STAGING_DIR_HOST` can have the following values: From patchwork Fri Sep 23 17:52:06 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13188 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 64F61C6FA83 for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay10.mail.gandi.net (relay10.mail.gandi.net [217.70.178.230]) by mx.groups.io with SMTP id smtpd.web09.565.1663955619266287598 for ; Fri, 23 Sep 2022 10:53:39 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=oyWj1NlN; spf=pass (domain: bootlin.com, ip: 217.70.178.230, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 596CA240003; Fri, 23 Sep 2022 17:53:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955617; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=wcSKHjW1pCEaNgzb1YaJhXbrOOGi6sUvKa3XyqXfuZg=; b=oyWj1NlNzwmfXE/dTSvcNJYHMc/veawd6UW4yWrd9jjaqD2TPqd3rqlDmAb3XRJPTmnEvz Rlo5h5lf2Y+CmoHNrF8xbmoXv/Zu1gtlaF0VSnkzEPkyJ2eYOitq3vPQXwDzkcuHpAdnNv CwtK6jdkRlXe13r5td8Lw8b/AvapPZhfDZmBizr7T60kYLWYBz3ksSWQGPWThKaILhS00Z EghOFQ4BBqSvvHIUVPMrjozaibk1VDg1HJmHLBRReUTMFvKrGu4p0aYrrLPVpWp0vohgN8 sC99DrcFtCmio8sqnyHftnaGdb5sYuX2m14hCJ8HREIkyabk1wJfQx0UaxDYbQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 17/30] manuals: add references to the "do_unpack" task Date: Fri, 23 Sep 2022 19:52:06 +0200 Message-Id: <20220923175219.6652-18-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3232 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/migration-guides/migration-1.3.rst | 2 +- documentation/overview-manual/concepts.rst | 2 +- documentation/ref-manual/tasks.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 5332b21c4a..8a087850b6 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9633,7 +9633,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`, +behavior in most cases is: :ref:`ref-tasks-fetch`, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch`, :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`, :ref:`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, diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 09fc39d3ca..3ba189b773 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst @@ -62,7 +62,7 @@ Previously, an inconsistent mix of spaces and tabs existed, which made extending these functions using ``_append`` or ``_prepend`` complicated given that Python treats whitespace as syntactically significant. If you are defining or extending any Python functions (e.g. -``populate_packages``, ``do_unpack``, :ref:`ref-tasks-patch` and so forth) in +``populate_packages``, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch` and so forth) in custom recipes or classes, you need to ensure you are using consistent four-space indentation. diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 423f645740..2aa7676324 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1208,7 +1208,7 @@ end result. 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``, :ref:`ref-tasks-patch`, +to run any of the :ref:`ref-tasks-fetch`, :ref:`ref-tasks-unpack`, :ref:`ref-tasks-patch`, :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install` tasks. However, if :ref:`ref-tasks-package` needs to be run, BitBake needs to run those other tasks. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index bf3a038b1a..dcfc2679ee 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -447,7 +447,7 @@ Validates the :term:`SRC_URI` value. ------------ Removes all output files for a target from the -:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``, +:ref:`ref-tasks-unpack` task forward (i.e. :ref:`ref-tasks-unpack`, :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, and From patchwork Fri Sep 23 17:52:07 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13186 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 70A18C6FA93 for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web08.583.1663955620464157350 for ; Fri, 23 Sep 2022 10:53:40 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=HSvBv+fg; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id CCF3920005; Fri, 23 Sep 2022 17:53:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955619; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=RpgGBGBJilhZqjL78Wpl5jz4CJHBX89UDO2oKj6I2oQ=; b=HSvBv+fgXHJomcn/IE1+Ovnq+L9nqq/pjKGuYNQ7aVdnMgM7RI9yFqE7e7/JPS99iV1htj CgIm2Xsal8K7ho24/nn4Jy5KIxvPIZRnDbtb1wexAiWxMvMLVw+uZZlXsV8Jpl+b3zunjM o4gfzX4PkkhgM0JNgD8I6rLrQ7C5Aqez0XlrOsrVJ2IBilcMBL9FjMMwQQLzARfMvWJc06 AiGYbXPpqGSTYWUVaSRdt4SB39400DcoVszSKkbyiKdfuXzOOJerKWLpGwNOihBZxQRqfQ FaDyGZWh5Ad2z7F6IDDt0KwXzvfCicorMLbzKjDm5FQJIlAmRhaa0l0m2rGSdg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 18/30] dev-manual: common-tasks.rst: add reference to "do_clean" task Date: Fri, 23 Sep 2022 19:52:07 +0200 Message-Id: <20220923175219.6652-19-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3233 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 8a087850b6..cf4d12f388 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3458,7 +3458,7 @@ Follow these general steps: .. note:: All the modifications you make to the temporary source code disappear - once you run the ``do_clean`` or ``do_cleanall`` tasks using BitBake + once you run the :ref:`ref-tasks-clean` or ``do_cleanall`` tasks using BitBake (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). Modifications will also disappear if you use the ``rm_work`` feature as described in the From patchwork Fri Sep 23 17:52:08 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13189 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 707E8C6FA92 for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web11.591.1663955622342718051 for ; Fri, 23 Sep 2022 10:53:42 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=EqzitSvb; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 73E6AFF802; Fri, 23 Sep 2022 17:53:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955620; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=zMht8FIjAvdFqHbe6lCGXENztrX2OKW5K9L49z19B4U=; b=EqzitSvbMTt6sv6TmE+K7ljEiEX/bNc4dbAgxukE6up8x4EaPU5qJnPYDVZRthQ9EMA2AH d64wozPKUo9wl1lIMRSIPm9K0g8m0d3Mjgc40VXPHYvyLA+xZEANLM8yXHD07pcotcO34n gE4pKF80l8Yc7PjPiv2koZjT9sohge5pz+NX0fPfj0ONhNW6ICE8GLTJe1njzVWJ+Hmi/V l7cE1VzfxM3WEO2UCGBlcboZLFSAA4vH3uOFXh8hi9eSCWYbXrCqu6VJuIGCBMc+vl+cfi qKyN/5zYYEGO/rlkoiXezGle8YjQZPiHTzellyOH7mkYJ7PZum7M2WCEsdw+BQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 19/30] manuals: add references to the "do_cleanall" task Date: Fri, 23 Sep 2022 19:52:08 +0200 Message-Id: <20220923175219.6652-20-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3234 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/ref-manual/tasks.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index cf4d12f388..c3be8b72b4 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3458,7 +3458,7 @@ Follow these general steps: .. note:: All the modifications you make to the temporary source code disappear - once you run the :ref:`ref-tasks-clean` or ``do_cleanall`` tasks using BitBake + once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` tasks using BitBake (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). Modifications will also disappear if you use the ``rm_work`` feature as described in the diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index dcfc2679ee..7eb48dcba3 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -473,7 +473,7 @@ use the :ref:`ref-tasks-cleansstate` task instead Removes all output files, shared state (:ref:`sstate `) cache, and downloaded source files for a target (i.e. the contents of -:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is +:term:`DL_DIR`). Essentially, the :ref:`ref-tasks-cleanall` task is identical to the :ref:`ref-tasks-cleansstate` task with the added removal of downloaded source files. @@ -481,7 +481,7 @@ You can run this task using BitBake as follows:: $ bitbake -c cleanall recipe -Typically, you would not normally use the ``cleanall`` task. Do so only +Typically, you would not normally use the :ref:`ref-tasks-cleanall` task. Do so only if you want to start fresh with the :ref:`ref-tasks-fetch` task. From patchwork Fri Sep 23 17:52:09 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13187 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 63D06C07E9D for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web12.544.1663955623812067820 for ; Fri, 23 Sep 2022 10:53:44 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=pmuCCvu7; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 3C3361BF204; Fri, 23 Sep 2022 17:53:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955622; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HRIXT8nu04+gqOhX4kEiet9v6UnFrYKniKFlSUhyMdM=; b=pmuCCvu7+O0h/XX4eXpri0OWkFKL8qa12qPADI1PJykYXTLv2t5JvOgy7wGoCematPWWit Nlk7VzQQFDgo1edvw8rAxE/iHX8x6CHZga9LVzEVPtan2hGQgaLAxoVz77b0IiQavhNqBc uMKd8XvCXWe15/3r8S62gzPw9K6U6nCd76GXnpltAddCeA33pgT0Q93JFXW+YXp5ig+lwe RHpErzoROisNs4MsY/kChJPizGmmKdQiYpvzxzd542p1hlx/LVlRVQFLnEnHEwdLzUChlI 6fe6Zj4Oohs9JExtPUhoT3EBZkY5gCLetSGHymhFOBCBgm6alkpDwx+Q6vu/hg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 20/30] ref-manual: tasks.rst: add references to the "do_cleansstate" task Date: Fri, 23 Sep 2022 19:52:09 +0200 Message-Id: <20220923175219.6652-21-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3235 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/ref-manual/tasks.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 7eb48dcba3..7c4be3e86f 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -492,7 +492,7 @@ task. Removes all output files and shared state (:ref:`sstate `) cache for a -target. Essentially, the ``do_cleansstate`` task is identical to the +target. Essentially, the :ref:`ref-tasks-cleansstate` task is identical to the :ref:`ref-tasks-clean` task with the added removal of shared state (:ref:`sstate `) cache. @@ -501,13 +501,13 @@ You can run this task using BitBake as follows:: $ bitbake -c cleansstate recipe -When you run the ``do_cleansstate`` task, the OpenEmbedded build system +When you run the :ref:`ref-tasks-cleansstate` task, the OpenEmbedded build system no longer uses any sstate. Consequently, building the recipe from scratch is guaranteed. .. note:: - The ``do_cleansstate`` task cannot remove sstate from a remote sstate + The :ref:`ref-tasks-cleansstate` task cannot remove sstate from a remote sstate mirror. If you need to build a target from scratch using remote mirrors, use the "-f" option as follows:: From patchwork Fri Sep 23 17:52:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13184 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5F6C5C04A95 for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web09.567.1663955625492115249 for ; Fri, 23 Sep 2022 10:53:45 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=fPMaISij; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id D14931BF206; Fri, 23 Sep 2022 17:53:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955624; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xpMSUrnvNXo/TnX/8W7m5dTReHtoaK29YUS6jTSBf50=; b=fPMaISijHTtPFOJ1qpDCyZNpahaBtzuVm9ZaMLWLGEGajn8IiAc3l6OTsiaBfM/3dKDe47 PnFSjFV7IamQi4NMGhV+SOrG8TneYHwhf16NUt15c5bs/avBNHffhd2vJHGFJ7ODSIzOb6 THtO20tSs7mCUuZqJThxLM2AVirQBe9HO7rgvrppt6byE+Up8sq2Qow+tlE48KSBBmGPcp MreVIf9XOLAdTq1jqkQSSPqjZXFJ7DaG4csPTIWm4JSRuzIlBWuZVLBqMDCKWSs/62LeAW oe5uKBiNGxI1xnv3XYQUCti3hICjd2nnYXwE9AP0j916q+DfqLG1QleWyYiVQA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 21/30] manuals: add references to the "do_devshell" task Date: Fri, 23 Sep 2022 19:52:10 +0200 Message-Id: <20220923175219.6652-22-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3236 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/ref-manual/classes.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index c3be8b72b4..efed327cea 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9637,7 +9637,7 @@ behavior in most cases is: :ref:`ref-tasks-fetch`, :ref:`ref-tasks-unpack`, :ref :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, :ref:`ref-tasks-install`, :ref:`ref-tasks-package`, :ref:`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 +such as :ref:`ref-tasks-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 use the ``-c`` option in BitBake. Here is an example:: diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 033284a46c..8e8a0baaf0 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -444,7 +444,7 @@ staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. ``devshell.bbclass`` ==================== -The ``devshell`` class adds the ``do_devshell`` task. Distribution +The ``devshell`` class adds the :ref:`ref-tasks-devshell` task. Distribution policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the Yocto Project Development Tasks Manual for more information about using ``devshell``. From patchwork Fri Sep 23 17:52:11 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13185 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6E29FC6FA82 for ; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web08.585.1663955627679860721 for ; Fri, 23 Sep 2022 10:53:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=QK7xGLBi; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 8F4B2240006; Fri, 23 Sep 2022 17:53:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955625; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=9uYMZQ/EiIfKvUeLMcSast5karGj6JDSBw3LFxOeKrw=; b=QK7xGLBisJhBoez95W7b1A6tQBojndE4lEh9ujBdXSNSGOClGR0/oLLRKn/7jxR/4LDJsQ lx4kT2iL8B9spEG4O0v6hEUNl8Ma7EmPFb68UPBksTxU7QCkdugdezsa4/Z9FfFF92yVEX ECuxmvFlrModCcYH8I5t75NPHx+npmZR5F2lnI+4tOqNJ9PANMb/BjQHo4BGhKDnHndtro BfXlaD8+0usI+/Am3PlumysjNsCcAz26YL4n0Z0v0ZdAFXphDHQ9AOxwtSug02aG+sBRqs RSrSYX9sW2Ctkhjy+RrsRNwHuScItqbmw25VlIoloVASsqgpOy8ZxQjA0fMPCQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 22/30] dev-manual: common-tasks.rst: add reference to "do_listtasks" task Date: Fri, 23 Sep 2022 19:52:11 +0200 Message-Id: <20220923175219.6652-23-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:49 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3237 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index efed327cea..8b77568d83 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -9724,7 +9724,7 @@ task dependency mechanisms. You can view a list of tasks in a given package by running the -``do_listtasks`` task as follows:: +:ref:`ref-tasks-listtasks` task as follows:: $ bitbake matchbox-desktop -c listtasks From patchwork Fri Sep 23 17:52:12 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13190 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6239EC6FA82 for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web08.587.1663955629896811685 for ; Fri, 23 Sep 2022 10:53:50 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=iiKum+Gz; spf=pass (domain: bootlin.com, ip: 217.70.183.198, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 94BB9C0003; Fri, 23 Sep 2022 17:53:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955627; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5ZJzs5jAvGC6wM5sVVJE8sPxsNtfWVMduvdfvzuT4QM=; b=iiKum+Gzt/lKOicYZUAgy/lv9UpxbYPDfTnhyBbjZshdjZJTcqc8QwLYu+7T04HuBlMQ3K ukV7PAUiZPKLCzFfYgQlUu53eZa355PXu1DhZn5dMQ5zztm+TMeqGRymuBEZ7tdcz7STX2 mdzm9VMT5V9eX3RYj5Jxhsc7ojgih+M+fSe5qXi8PlXfXmVYljoY5fjwJRvcFjeIP3WvCh SHSiJ8xobCfj51X7kL4cqowhDFJYAXCwTtaJ81FioaSYUtSz3kYWOyr79EDRq+8UYmtDbC P+tE4AISjcf/M+06PdDSjMJnIKWAzIefRcrFiT1t0bYYI76EYuVnIwxL/vCuXw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 23/30] manuals: add references to the "do_bundle_initramfs" task Date: Fri, 23 Sep 2022 19:52:12 +0200 Message-Id: <20220923175219.6652-24-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3238 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 2 +- documentation/ref-manual/variables.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 8b77568d83..b20b9f374b 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3995,7 +3995,7 @@ To achieve this, you need to perform some additional steps: buildsystem know where the :term:`INITRAMFS_IMAGE` will be located. Building a system with such configuration will build the kernel using the - main configuration but the ``do_bundle_initramfs`` task will grab the + main configuration but the :ref:`ref-tasks-bundle_initramfs` task will grab the selected :term:`INITRAMFS_IMAGE` from :term:`INITRAMFS_DEPLOY_DIR_IMAGE` instead, resulting in a musl based initramfs image bundled in the kernel but a glibc based main image. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 79c64dc97a..afe789ff57 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3633,7 +3633,7 @@ system and gives an overview of their function and contents. needed for the build that are not strippable. :term:`INITRAMFS_DEPLOY_DIR_IMAGE` - Indicates the deploy directory used by ``do_bundle_initramfs`` where the + Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs` where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is set by default to ``${DEPLOY_DIR_IMAGE}`` in the :ref:`kernel ` class and it's only meant to be changed From patchwork Fri Sep 23 17:52:13 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13195 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 71E29C6FA86 for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay12.mail.gandi.net (relay12.mail.gandi.net [217.70.178.232]) by mx.groups.io with SMTP id smtpd.web12.546.1663955630968949249 for ; Fri, 23 Sep 2022 10:53:51 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=erlJ7XD8; spf=pass (domain: bootlin.com, ip: 217.70.178.232, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 2E5F9200003; Fri, 23 Sep 2022 17:53:49 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955629; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Bn3GmiKr9qdTXOSD67WPPr2MHSHqglnLGWPfV3pUR/Y=; b=erlJ7XD84O5Py08kCkEL9PVQRvUHjy1S9en42bK2NdvLb6G26edMs4nBavGDFTXP1q7eCn 5iwH3KoTiyjt5OU/Gw/s3UizeFA5xA/mFU3LrZu9kgVu24f+bdnsYVfZoMbCRcPCzbRpD0 Ry42JUOVrWVn1hQh0ZtQZm3I/AgaNO0UtkIy4c6q4CSYL8VZ+e6fwQY92i8ABEm5IuEL+T 0sidlDFqLTQbut+fm+giEE+QhJdvf989j9eS6m027dnsUg5qjiu3DlhWkaxgkTJmtDm85n /HWNOwAXCQ2SP76gwGf+ycikAaM+ISvdBPjYXpCDAwkQI4WSXSTWu0r5a40lKA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 24/30] manuals: add references to the "do_rootfs" task Date: Fri, 23 Sep 2022 19:52:13 +0200 Message-Id: <20220923175219.6652-25-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3239 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/dev-manual/common-tasks.rst | 6 +++--- documentation/migration-guides/migration-2.1.rst | 8 ++++---- documentation/migration-guides/migration-2.5.rst | 2 +- documentation/overview-manual/concepts.rst | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index b20b9f374b..d00aeab72a 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -3854,7 +3854,7 @@ to be added to the recipe that builds the ``core-image-sato`` image:: In this example, the `from_multiconfig` is "x86". The `to_multiconfig` is "arm". The task on which the :ref:`ref-tasks-image` task in the recipe depends is the -``do_rootfs`` task from the ``core-image-minimal`` recipe associated +:ref:`ref-tasks-rootfs` task from the ``core-image-minimal`` recipe associated with the "arm" multiconfig. Once you set up this dependency, you can build the "x86" multiconfig @@ -3864,7 +3864,7 @@ using a BitBake command as follows:: This command executes all the tasks needed to create the ``core-image-sato`` image for the "x86" multiconfig. Because of the -dependency, BitBake also executes through the ``do_rootfs`` task for the +dependency, BitBake also executes through the :ref:`ref-tasks-rootfs` task for the "arm" multiconfig build. Having a recipe depend on the root filesystem of another build might not @@ -9081,7 +9081,7 @@ Class methods are as follows: - *hasPackage(pkg):* Returns "True" if ``pkg`` is in the installed package list of the image, which is based on the manifest file that - is generated during the ``do_rootfs`` task. + is generated during the :ref:`ref-tasks-rootfs` task. - *hasFeature(feature):* Returns "True" if the feature is in :term:`IMAGE_FEATURES` or diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index bfc600ccca..c19ba5501c 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst @@ -128,12 +128,12 @@ separate :ref:`ref-tasks-image` tasks for clarity both in operation and in the code. For most cases, this change does not present any problems. However, if -you have made customizations that directly modify the ``do_rootfs`` task -or that mention ``do_rootfs``, you might need to update those changes. -In particular, if you had added any tasks after ``do_rootfs``, you +you have made customizations that directly modify the :ref:`ref-tasks-rootfs` task +or that mention :ref:`ref-tasks-rootfs`, you might need to update those changes. +In particular, if you had added any tasks after :ref:`ref-tasks-rootfs`, you should make edits so that those tasks are after the :ref:`ref-tasks-image-complete` task rather than -after ``do_rootfs`` so that your added tasks run at the correct +after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct time. A minor part of this restructuring is that the post-processing diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index abd26809df..04f4cd7e73 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst @@ -261,7 +261,7 @@ The following are additional changes: ``pkg_postinst_ontarget()`` or call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. Any failure of a ``pkg_postinst()`` script (including ``exit 1``) - will trigger a warning during ``do_rootfs``. + will trigger a warning during :ref:`ref-tasks-rootfs`. For more information, see the ":ref:`dev-manual/common-tasks:post-installation scripts`" diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 2aa7676324..8b8625a080 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst @@ -1012,7 +1012,7 @@ all the post installation scripts must succeed on the build host during the package installation phase since the root filesystem on the target is read-only. -The final stages of the ``do_rootfs`` task handle post processing. Post +The final stages of the :ref:`ref-tasks-rootfs` task handle post processing. Post processing includes creation of a manifest file and optimizations. The manifest file (``.manifest``) resides in the same directory as the From patchwork Fri Sep 23 17:52:14 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13194 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B09EC6FA83 for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web11.595.1663955632659465310 for ; Fri, 23 Sep 2022 10:53:53 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=RDPS5ew3; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 0AD2160009; Fri, 23 Sep 2022 17:53:50 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955631; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=M54nDVDFy8oOzIEkxUrFvSdcFKyY18RI4Bx4NXYPFow=; b=RDPS5ew3of9piX75st0w1ex63aTELInVf8FyAByqzSaRr7mR80mjBlpTFs+vQPyfuH7Qge 4JsvoZ6Viqq24z18FHu1yhEP5wy5b9sCIeaJq3GwVQnjfTtNizkhjHNReC8kGr4qnNSxgi tVKahdWITpHO6UHQUqobYxnAAjNtKHZBfm1d59urTxzjp9UCPYyHd9PkN/3ApBUwwD2fhX csqUINVULEUk9fTs0lz5fQgVJ8+vgVYs6/VGyoeB5JUn05sOQFK86/9iMXvIeoeBXngQU2 Kdwfts64LLmPw3qr09RaHnFWFdraqaVu2qDIU2m8SAXmmGsvta7yicniLLN8pQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 25/30] ref-manual: tasks.rst: add reference to the "do_kernel_checkout" task Date: Fri, 23 Sep 2022 19:52:14 +0200 Message-Id: <20220923175219.6652-26-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3240 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/ref-manual/tasks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 7c4be3e86f..673068a3e7 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -657,7 +657,7 @@ section in the Yocto Project Linux Kernel Development Manual. Converts the newly unpacked kernel source into a form with which the OpenEmbedded build system can work. Because the kernel source can be -fetched in several different ways, the ``do_kernel_checkout`` task makes +fetched in several different ways, the :ref:`ref-tasks-kernel_checkout` task makes sure that subsequent tasks are given a clean working tree copy of the kernel with the correct branches checked out. From patchwork Fri Sep 23 17:52:15 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13193 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 62B8FC07E9D for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web09.568.1663955634278420073 for ; Fri, 23 Sep 2022 10:53:54 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=K4FRVTX8; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id ADFE660005; Fri, 23 Sep 2022 17:53:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955633; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=OzYAKs1fazu0VEZ6Z+srTbnoGGlA2g87pMq3SlOVJQA=; b=K4FRVTX8dOeNb4x9E4p3CfyYclxFU/aFOwNo4uG0ZQI/QCaNHzp3CpHUq0JkRAQ10CHEPQ m76ChzivjVFR2UotbXmHBfoTZd2eJSovM4U/8U3zIxVxxM5yPBgIN/qHXg3NnS2jUSwKc0 oB3SxY2f3j3OOp3vaJvpKPj6vcU4NDJJG18Jj0uDQb5av7WdOm41pFkLeGB6U7IYeMA+SS 7C4FIP0oXAkQFkBFhnZEhTKhFR7lW1ESMXIRw6s1AWB2VbDDUKniWcHiudL6TaBxC866VS FSxruksKo9hJeA8y9h1MJONvBdin7LKfPbwtuzvqJaHKlDSmvwX5bbSxHWRZ7g== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 26/30] manuals: add reference to the "do_kernel_configcheck" task Date: Fri, 23 Sep 2022 19:52:15 +0200 Message-Id: <20220923175219.6652-27-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3241 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/kernel-dev/common.rst | 10 +++++----- documentation/ref-manual/tasks.rst | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index fb8d7cd029..f370350264 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -1316,7 +1316,7 @@ In order to run this task, you must have an existing ``.config`` file. See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" section for information on how to create a configuration file. -Following is sample output from the ``do_kernel_configcheck`` task: +Following is sample output from the :ref:`ref-tasks-kernel_configcheck` task: .. code-block:: none @@ -1396,7 +1396,7 @@ possible by reading the output of the kernel configuration fragment audit, noting any issues, making changes to correct the issues, and then repeating. -As part of the kernel build process, the ``do_kernel_configcheck`` task +As part of the kernel build process, the :ref:`ref-tasks-kernel_configcheck` task runs. This task validates the kernel configuration by checking the final ``.config`` file against the input files. During the check, the task produces warning messages for the following issues: @@ -1430,13 +1430,13 @@ To streamline the configuration, do the following: successfully. Use this configuration file as your baseline. 2. *Run Configure and Check Tasks:* Separately run the - ``do_kernel_configme`` and ``do_kernel_configcheck`` tasks:: + ``do_kernel_configme`` and :ref:`ref-tasks-kernel_configcheck` tasks:: $ bitbake linux-yocto -c kernel_configme -f $ bitbake linux-yocto -c kernel_configcheck -f 3. *Process the Results:* Take the resulting list of files from the - ``do_kernel_configcheck`` task warnings and do the following: + :ref:`ref-tasks-kernel_configcheck` task warnings and do the following: - Drop values that are redefined in the fragment but do not change the final ``.config`` file. @@ -1450,7 +1450,7 @@ To streamline the configuration, do the following: 4. *Re-Run Configure and Check Tasks:* After you have worked through the output of the kernel configuration audit, you can re-run the - ``do_kernel_configme`` and ``do_kernel_configcheck`` tasks to see the + ``do_kernel_configme`` and :ref:`ref-tasks-kernel_configcheck` tasks to see the results of your changes. If you have more issues, you can deal with them as described in the previous step. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 673068a3e7..faffe94eb1 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -668,7 +668,7 @@ kernel with the correct branches checked out. Validates the configuration produced by the :ref:`ref-tasks-kernel_menuconfig` task. The -``do_kernel_configcheck`` task produces warnings when a requested +:ref:`ref-tasks-kernel_configcheck` task produces warnings when a requested configuration does not appear in the final ``.config`` file or when you override a policy configuration in a hardware configuration fragment. You can run this task explicitly and view the output by using the From patchwork Fri Sep 23 17:52:16 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13191 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5FA99C04A95 for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web09.569.1663955635945768289 for ; Fri, 23 Sep 2022 10:53:56 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=RVer2O+2; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 5319220004; Fri, 23 Sep 2022 17:53:54 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955634; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=7jlZdpUt4z72CI/opMulp5rsJKLNdLgXaRF55Hv7o+k=; b=RVer2O+2LZfKB3eKuVX5McZAhdbtxrxfJI1MJdWDjp+apTLmn25RCptbRJO2qhtVgQ1sJN qxexwMZRk8k8nWDJqDjfZILONZ2I7oBO++j7+iVrb/Dy0+A/uDpDYOgu4TTL+TQzAImL7y smdKHhdLkJOKGfl4rTraZMswJWkFDePIh83H+K0L/Hc1JH9J9PmaRUE32LNbU4oN+gQj5x /VkiTP/EdtYbd6GJdKWNGmbiu0Wj5NVjV3J0Qd1L4/OZ3nKrgGAA+Ej672QC2wduKeJdpF Uygx245NxEDIzbnCQdk/ku9vHtkypydujIlRwAZPyWed0j/5c5cmoPuD8PqZZQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 27/30] manuals: add references to the "do_kernel_configme" task Date: Fri, 23 Sep 2022 19:52:16 +0200 Message-Id: <20220923175219.6652-28-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3242 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/kernel-dev/common.rst | 4 ++-- documentation/ref-manual/tasks.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index f370350264..0a1819ceae 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst @@ -1430,7 +1430,7 @@ To streamline the configuration, do the following: successfully. Use this configuration file as your baseline. 2. *Run Configure and Check Tasks:* Separately run the - ``do_kernel_configme`` and :ref:`ref-tasks-kernel_configcheck` tasks:: + :ref:`ref-tasks-kernel_configme` and :ref:`ref-tasks-kernel_configcheck` tasks:: $ bitbake linux-yocto -c kernel_configme -f $ bitbake linux-yocto -c kernel_configcheck -f @@ -1450,7 +1450,7 @@ To streamline the configuration, do the following: 4. *Re-Run Configure and Check Tasks:* After you have worked through the output of the kernel configuration audit, you can re-run the - ``do_kernel_configme`` and :ref:`ref-tasks-kernel_configcheck` tasks to see the + :ref:`ref-tasks-kernel_configme` and :ref:`ref-tasks-kernel_configcheck` tasks to see the results of your changes. If you have more issues, you can deal with them as described in the previous step. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index faffe94eb1..29a135beb0 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -686,7 +686,7 @@ section in the Yocto Project Linux Kernel Development Manual. ---------------------- After the kernel is patched by the :ref:`ref-tasks-patch` -task, the ``do_kernel_configme`` task assembles and merges all the +task, the :ref:`ref-tasks-kernel_configme` task assembles and merges all the kernel config fragments into a merged configuration that can then be passed to the kernel configuration phase proper. This is also the time during which user-specified defconfigs are applied if present, and where From patchwork Fri Sep 23 17:52:17 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13192 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 6B20BC6FA92 for ; Fri, 23 Sep 2022 17:53:59 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web08.588.1663955637368715560 for ; Fri, 23 Sep 2022 10:53:57 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=LPj759OR; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id C612B20007; Fri, 23 Sep 2022 17:53:55 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955636; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=KYdSkaImXj/M6KmzjUkQI+CZNtfBajfA0Rs/dUX1DB0=; b=LPj759OR4pcGymjxHo+NNEKXcZHR7XSCdhP4QZDFymHqrhcnACafGe+Pdir/GiYetL0hZx YRMpCD1ZmIffycrJ+p7LYMAtB8lT/nt0T2m2SAI9c25Fj0p0t3ptwbeK7KNsASfI/1v/zW GDTG6OY8uI8ypG6fga3MHM2s5PrdwyLNTuX/ebx0FdCAcXKS31aVq5Rqp4M6Tl++9JU721 bH3KoCSTzGiBt9pXtnS9d0gx7I1fcyQ6W+No8PWY+CKrbK7J5JKE73R8S+fCEXyGOLKBSa I8taNFQsOv8uGleqaziuFPxhFQpKNJM1K4FjZS8qrySwtREokMGiewXbcoRqdQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 28/30] ref-manual: tasks.rst: add reference to the "do_kernel_metadata" task Date: Fri, 23 Sep 2022 19:52:17 +0200 Message-Id: <20220923175219.6652-29-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:53:59 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3243 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/ref-manual/tasks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 29a135beb0..ce900119ef 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -719,7 +719,7 @@ information on this configuration tool. Collects all the features required for a given kernel build, whether the features come from :term:`SRC_URI` or from Git -repositories. After collection, the ``do_kernel_metadata`` task +repositories. After collection, the :ref:`ref-tasks-kernel_metadata` task processes the features into a series of config fragments and patches, which can then be applied by subsequent tasks such as :ref:`ref-tasks-patch` and From patchwork Fri Sep 23 17:52:18 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13196 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5E7EEC07E9D for ; Fri, 23 Sep 2022 17:54:09 +0000 (UTC) Received: from relay11.mail.gandi.net (relay11.mail.gandi.net [217.70.178.231]) by mx.groups.io with SMTP id smtpd.web09.571.1663955639129863315 for ; Fri, 23 Sep 2022 10:53:59 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=OQHpqgKs; spf=pass (domain: bootlin.com, ip: 217.70.178.231, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 7A44E100006; Fri, 23 Sep 2022 17:53:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955637; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=LGVX2sxmMDzZxbHsPScpCBxa4Ch2bxPldcTf6gklzas=; b=OQHpqgKsi15i9EIAiHtfHmrStEJvNS8xCwO8gc6if2+iU7pHY4nI3F3xf9WOC0VnMtu3w0 RYYjdYHbfSTRWbz+8bY2ctTKhUbapZEwc45ldKUBgoOLRiodvZDuXUtSMUqdtlUBBNDYy2 m/UW/JjhEIqIUgkD03rbWdhpMIN/Lp/HakN+XCTujyJMnJe6kjcVEGMZ2yyyuxpyFc3Z0G fT4ndojZrQMFFgKyeb30E8b/zRgcWJEkYxBgNZGoZ4SmpoFMSZaqJxaXYmO0K6vpxZlNqH 3gZrf1HU8iqNqkIXPTanRNFBy58P8fd9GbyeITS+6Y9FFqrIFI9AfrQWeD2ckw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 29/30] migration-guides: add reference to the "do_shared_workdir" task Date: Fri, 23 Sep 2022 19:52:18 +0200 Message-Id: <20220923175219.6652-30-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:54:09 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3244 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/migration-guides/migration-1.8.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst index 546c798196..f058029b30 100644 --- a/documentation/migration-guides/migration-1.8.rst +++ b/documentation/migration-guides/migration-1.8.rst @@ -84,7 +84,7 @@ where the ``linux.inc`` file in ``meta-oe`` was updated. Recipes that rely on the kernel source code and do not inherit the module classes might need to add explicit dependencies on the -``do_shared_workdir`` kernel task, for example:: +:ref:`ref-tasks-shared_workdir` kernel task, for example:: do_configure[depends] += "virtual/kernel:do_shared_workdir" From patchwork Fri Sep 23 17:52:19 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 13197 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 617ADC6FA82 for ; Fri, 23 Sep 2022 17:54:09 +0000 (UTC) Received: from relay1-d.mail.gandi.net (relay1-d.mail.gandi.net [217.70.183.193]) by mx.groups.io with SMTP id smtpd.web12.550.1663955641034419003 for ; Fri, 23 Sep 2022 10:54:01 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=I29VxsY6; spf=pass (domain: bootlin.com, ip: 217.70.183.193, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id 2C652240002; Fri, 23 Sep 2022 17:53:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1663955639; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=INUFoNUKPTPvU9S3eChp08O9fbv6EnEJCMq2170Ct74=; b=I29VxsY6leGLaL7hPuyHnJO/d5ToYM31kfUq1AS8OofFdS5wj3shvv6kcC8MAmYQq9YqhX xL4i+aFmBuTkSXl2eYUGIA+qyeyYYO0gLehQE7nhBFVKJL1mgps4YFR+ORDyIG4H/DlL+n ZoLniJrmPosO/f5qYWneOrUhH+xSTwMD/LMIwq2E3zfZnN03MIHaTqPhBTx3p4OBNEYvyg GHn5dmiHLqKMW3vX9gjJX/txwcgVxydU1rTQS94+6hMINPoxaVKOim/AUkP1IfkPhG9kyg xg1TLz39g/C+nJhhIb7E8Cv71lc+1b0kGWD4Su1zIBZlzDvVrOH65JoS5gmjmA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Quentin Schulz Subject: [PATCH 30/30] ref-manual: tasks.rst: add reference to the "do_validate_branches" task Date: Fri, 23 Sep 2022 19:52:19 +0200 Message-Id: <20220923175219.6652-31-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com> References: <20220923175219.6652-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 23 Sep 2022 17:54:09 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3245 From: Michael Opdenacker [YOCTO #14508] Reported-by: Quentin Schulz Signed-off-by: Michael Opdenacker --- documentation/ref-manual/tasks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index ce900119ef..d54bb35bb5 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -791,4 +791,4 @@ After the kernel is unpacked but before it is patched, this task makes sure that the machine and metadata branches as specified by the :term:`SRCREV` variables actually exist on the specified branches. Otherwise, if :term:`AUTOREV` is not being used, the -``do_validate_branches`` task fails during the build. +:ref:`ref-tasks-validate_branches` task fails during the build.