[PATCH 0/1] Make do_clean description more explicit

[PATCH 0/1] Make do_clean description more explicit

[anis]

The same proposal has been made for yocto-docs
where the patch is under review.

anis (1):
  conf/documentation.conf: Make do_clean description more explicit

 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.50.1 (Apple Git-155)

[PATCH 1/1] conf/documentation.conf: Make do_clean description more explicit

[anis]

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>
---
 meta/conf/documentation.conf | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf
index 4c5a5ee8c2..72513296e2 100644
--- a/meta/conf/documentation.conf
+++ b/meta/conf/documentation.conf
@@ -8,7 +8,7 @@ do_bootimg[doc] = "Creates a bootable live image"
 do_build[doc] = "Default task for a recipe - depends on all other normal tasks required to 'build' a recipe"
 do_bundle_initramfs[doc] = "Combines an initial ramdisk image and kernel together to form a single image"
 do_checkuri[doc] = "Validates the SRC_URI value"
-do_clean[doc] = "Removes all output files for a target"
+do_clean[doc] = "Removes all output files for a target including ${WORKDIR}, sstate manifests and stamps"
 do_cleanall[doc] = "Removes all output files, shared state cache, and downloaded source files for a target"
 do_cleansstate[doc] = "Removes all output files and shared state cache for a target"
 do_compile[doc] = "Compiles the source in the compilation directory"
-- 
2.50.1 (Apple Git-155)