[PATCH] ref-manual/tasks.rst: Make do_clean description more explicit
anis <[email protected]>
| Newsgroups | org.yoctoproject.lists.docs |
|---|---|
| Message-ID | <[email protected]> |
The current do_clean task description is generic and does not specify which files will be removed. This branch adds details about the files that are removed by explicitly listing the affected subdirectories. Signed-off-by: anis <[email protected]> --- 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..28de10d56 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 does remove the ``${``\ :term:`WORKDIR`\ ``}``, the sstate manifests +and the stamps. +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)