From: Anis Bougrine <anis.bougrine10@gmail.com>
To: docs@lists.yoctoproject.org
Cc: anis <anis.bougrine10@gmail.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [docs][PATCH v2] ref-manual/tasks.rst: make do_clean description more explicit
Date: Thu, 13 Aug 2026 20:55:52 +0200 [thread overview]
Message-ID: <20260813185552.47183-1-anis.bougrine10@gmail.com> (raw)
From: anis <anis.bougrine10@gmail.com>
The current do_clean task description is generic and does not
specify which files will be removed.
This commit adds details about the files that are removed by
explicitly listing the affected subdirectories.
Signed-off-by: anis <anis.bougrine10@gmail.com>
Cc: Antonin Godard <antonin.godard@bootlin.com>
---
changes in v2:
- Submit the corresponding OE-Core changes, which have been merged as
9b363e6d586863dc5e49795df9f1346836c466c5.
- Reformulate the sentence based on the v1 suggestions.
---
documentation/ref-manual/tasks.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 3517d0b91..fa6ba255d 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -17,7 +17,7 @@ you can run:
$ bitbake -c listtasks recipename
do_build Default task for a recipe - depends on all other normal tasks required to 'build' a recipe
do_checkuri Validates the SRC_URI value
- do_clean Removes all output files for a target
+ do_clean Removes all output files for a target (``${WORKDIR}``, sstate manifests and stamps)
do_cleanall Removes all output files, shared state cache, and downloaded source files for a target
do_cleansstate Removes all output files and shared state cache for a target
do_compile Compiles the source in the compilation directory
@@ -501,9 +501,10 @@ You can run this task using BitBake as follows::
$ bitbake -c clean recipe
-Running this task does not remove the
-:ref:`sstate <overview-manual/concepts:shared state cache>` cache files.
-Consequently, if no changes have been made and the recipe is rebuilt
+Running this task removes the working directory of the recipe (represented by its :term:`WORKDIR` value),
+the sstate manifests and the :ref:`stamps <overview-manual/concepts:Stamp Files and the Rerunning of Tasks>`.
+However, it does not remove the :ref:`sstate <overview-manual/concepts:shared state cache>`
+cache files. Consequently, if no changes have been made and the recipe is rebuilt
after cleaning, output files are simply restored from the sstate cache.
If you want to remove the sstate cache files for the recipe, you need to
use the :ref:`ref-tasks-cleansstate` task instead
--
2.50.1 (Apple Git-155)
next reply other threads:[~2026-08-13 18:56 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-13 18:55 Anis Bougrine [this message]
2026-08-14 7:25 ` [docs][PATCH v2] ref-manual/tasks.rst: make do_clean description more explicit Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260813185552.47183-1-anis.bougrine10@gmail.com \
--to=anis.bougrine10@gmail.com \
--cc=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox