diff mbox series

[v2] ref-manual/tasks.rst: make do_clean description more explicit

Message ID 20260813185552.47183-1-anis.bougrine10@gmail.com
State New
Headers show
Series [v2] ref-manual/tasks.rst: make do_clean description more explicit | expand

Commit Message

Anis Bougrine Aug. 13, 2026, 6:55 p.m. UTC 
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 mbox series

Patch

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