diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index 5bff93b1c5..a62b7ce9a6 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -88,8 +88,6 @@ SRC_URI variable and the argument's prefix to determine the correct fetcher module. - Unpacked source files reside in the - S directory. @@ -123,16 +121,6 @@ -
- <filename>do_package_index</filename> - - - Creates or updates the index in the - Package Feeds - area. - -
-
<filename>do_package_write_deb</filename> @@ -249,10 +237,16 @@ <filename>do_unpack</filename> - Unpacks the source code into a working directory. - For more information on fetching and unpacking source files, see the + Unpacks the source code into a working directory pointed to + by + ${WORKDIR}. + The + S variable also + plays a role in where unpacked source files ultimately reside. + For more information on how source files are unpacked, see the "Source Fetching" - section. + section and the WORKDIR and + S variable descriptions.
@@ -262,7 +256,7 @@ These tasks are typically manually triggered (e.g. by using the - bitbake -c command line option): + bitbake -c command-line option):
@@ -290,6 +284,16 @@ Removes all output files for a target. + When this task is run, the + sstate) cache + files are not deleted. + 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 + do_cleansstate + task instead (i.e. bitbake -c cleansstate <recipe>).
@@ -313,14 +317,6 @@ -
- <filename>do_fetchall</filename> - - - Fetches all remote sources required to build a target. - -
-
<filename>do_devshell</filename> @@ -334,6 +330,14 @@
+
+ <filename>do_fetchall</filename> + + + Fetches all remote sources required to build a target. + +
+
<filename>do_listtasks</filename> @@ -341,6 +345,25 @@ Lists all defined tasks for a target.
+ +
+ <filename>do_package_index</filename> + + + Creates or updates the index in the + Package Feeds + area. + + This task is not triggered with the + bitbake -c command-line option as + are the other tasks in this section. + Because this task is specifically for the + package-index recipe, + you run it using + bitbake package-index. + + +
@@ -399,6 +425,15 @@ Boots an image and performs runtime tests within the image immediately after it has been built. + This task is enabled when you set + TEST_IMAGE + equal to "1". + + + + For information on automatically testing images, see the + "Performing Automated Runtime Testing" + section in the Yocto Project Development Manual.