diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index a62b7ce9a6..d6d287b435 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -283,10 +283,28 @@ <filename>do_clean</filename> - Removes all output files for a target. - When this task is run, the + Removes all output files for a target from the + do_unpack + task forward (i.e. + do_unpack, + do_configure, + do_compile, + do_install, + and + do_package). + + + + You can run this task using BitBake as follows: + + $ bitbake -c clean <recipe> + + + + + Running this task does not remove the sstate) cache - files are not deleted. + files. Consequently, if no changes have been made and the recipe is rebuilt after cleaning, output files are simply restored from the sstate cache. @@ -304,6 +322,25 @@ Removes all output files, shared state (sstate) cache, and downloaded source files for a target. + Essentially, the do_cleanall task is + identical to the + do_cleansstate + task with the added removal of downloaded source files. + + + + 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 if you want to start fresh with the + do_fetch + task. @@ -314,8 +351,27 @@ Removes all output files and shared state (sstate) cache for a target. + Essentially, the do_cleansstate task is + identical to the + do_clean + task with the added removal of shared state + (sstate) cache. - + + + You can run this task using BitBake as follows: + + $ bitbake -c cleansstate <recipe> + + + + + When you run the do_cleanstate task, + the OpenEmbedded build system no longer uses any + sstate. + Consequently, building the recipe from scratch is guaranteed. + +
<filename>do_devshell</filename>