[19/30] manuals: add references to the "do_cleanall" task

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

Message ID

20220923175219.6652-20-michael.opdenacker@bootlin.com

State

New

Headers

From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	Quentin Schulz <foss@0leil.net>
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>
In-Reply-To: <20220923175219.6652-1-michael.opdenacker@bootlin.com>
References: <20220923175219.6652-1-michael.opdenacker@bootlin.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Series

manuals: add missing references to tasks | expand

Commit Message

Michael Opdenacker Sept. 23, 2022, 5:52 p.m. UTC

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

[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/common-tasks.rst | 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 <overview-manual/concepts:shared state cache>`) 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.

[19/30] manuals: add references to the "do_cleanall" task

Commit Message

Patch