From 2f4d0722ce42e6381228b335d2bbd5a5901bb594 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 9 May 2014 10:36:57 +0300 Subject: ref-manual: Added new chapter on task documentation Changes to support a new chapter on the 51 tasks that the OpenEmbedded build system defines. The changes include a new file called ref-tasks.xml, changes to the ref-manual.xml building file to include the new chapter, and a new bullet item to the list that describes what is in the reference manual. (From yocto-docs rev: a816746051ec025014e515fb848b3e0e58d4c7be) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/introduction.xml | 4 + documentation/ref-manual/ref-manual.xml | 2 + documentation/ref-manual/ref-tasks.xml | 497 ++++++++++++++++++++++++++++++ 3 files changed, 503 insertions(+) create mode 100644 documentation/ref-manual/ref-tasks.xml (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index f48489a563..a61740d48b 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -68,6 +68,10 @@ Classes: Describes the classes used in the Yocto Project. + + Tasks: + Describes the tasks defined by the OpenEmbedded build system. + Images: Describes the standard images that the Yocto Project supports. diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 22f652de55..1ec1458f2d 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml @@ -123,6 +123,8 @@ + + diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml new file mode 100644 index 0000000000..aea0858f73 --- /dev/null +++ b/documentation/ref-manual/ref-tasks.xml @@ -0,0 +1,497 @@ + %poky; ] > + + +Tasks + + + Tasks are units of execution for BitBake. + Recipes (.bb files) use tasks to complete + configuring, compiling, and packaging software. + This chapter provides a reference of the tasks defined in the + OpenEmbedded build system. + + +
+ Normal Recipe Build Tasks + + + The following sections describe normal tasks associated with building + a recipe. + + +
+ <filename>do_build</filename> + + + Default task for a recipe - depends on all other normal tasks + required to 'build' a recipe. + +
+ +
+ <filename>do_compile</filename> + + + Compiles the source in the compilation directory. + +
+ +
+ <filename>do_compile_ptest_base</filename> + + + Compiles the runtime test suite included in the software being + built. + +
+ +
+ <filename>do_configure</filename> + + + Configures the source by enabling and disabling any build-time and + configuration options for the software being built. + +
+ +
+ <filename>do_configure_ptest_base</filename> + + + Configures the runtime test suite included in the software being + built. + +
+ +
+ <filename>do_deploy</filename> + + + Writes deployable output files to the deploy directory. + +
+ +
+ <filename>do_fetch</filename> + + + Fetches the source code. + +
+ +
+ <filename>do_install</filename> + + + Copies files from the compilation directory to a holding area. + +
+ +
+ <filename>do_install_ptest_base</filename> + + + Copies the runtime test suite files from the compilation directory + to a holding area. + +
+ +
+ <filename>do_package</filename> + + + Analyzes the content of the holding area and splits it into subsets + based on available packages and files. + +
+ +
+ <filename>do_package_index</filename> + + + Creates or updates the index in the Package Feed area. + +
+ +
+ <filename>do_package_write_deb</filename> + + + Creates the actual DEB packages and places them in the Package Feed + area. + +
+ +
+ <filename>do_package_write_ipk</filename> + + + Creates the actual IPK packages and places them in the Package Feed + area. + +
+ +
+ <filename>do_package_write_rpm</filename> + + + Creates the actual RPM packages and places them in the Package Feed + area. + +
+ +
+ <filename>do_package_write_tar</filename> + + + Creates tar archives for packages and places them in the Package + Feed area. + +
+ +
+ <filename>do_packagedata</filename> + + + Creates package metadata used by the build system to generate the + final packages. + +
+ +
+ <filename>do_patch</filename> + + + Locates patch files and applies them to the source code. + +
+ +
+ <filename>do_populate_lic</filename> + + + Writes license information for the recipe that is collected later + when the image is constructed. + +
+ +
+ <filename>do_populate_sdk</filename> + + + Creates the file and directory structure for an installable SDK. + +
+ +
+ <filename>do_populate_sysroot</filename> + + + Copies a subset of files installed by do_install into the sysroot + in order to make them available to other recipes. + +
+ +
+ <filename>do_rm_work</filename> + + + Removes work files after the build system has finished with them. + +
+ +
+ <filename>do_rm_work_all</filename> + + + Top-level task for removing work files after the build system has + finished with them. + +
+ +
+ <filename>do_unpack</filename> + + + Unpacks the source code into a working directory. + +
+
+ +
+ Manually Called Tasks + + + These tasks are typically manually triggered (e.g. by using the + bitbake -c command line option): + + +
+ <filename>do_checkuri</filename> + + + Validates the SRC_URI value. + +
+ +
+ <filename>do_checkuriall</filename> + + + Validates the SRC_URI value for all recipes required to build a + target. + +
+ +
+ <filename>do_clean</filename> + + + Removes all output files for a target. + +
+ +
+ <filename>do_cleanall</filename> + + + Removes all output files, shared state cache, and downloaded source + files for a target. + +
+ +
+ <filename>do_cleansstate</filename> + + + Removes all output files and shared state cache for a target. + +
+ +
+ <filename>do_fetchall</filename> + + + Fetches all remote sources required to build a target. + +
+ +
+ <filename>do_devshell</filename> + + + Starts a shell with the environment set up for + development/debugging. + +
+ +
+ <filename>do_listtasks</filename> + + + Lists all defined tasks for a target. + +
+
+ + + + + +
+ Miscellaneous Tasks + + + The following sections describe miscellaneous tasks. + + +
+ <filename>do_generate_qt_config_file</filename> + + + Writes a qt.conf file for building a Qt-based application. + +
+ +
+ <filename>do_spdx</filename> + + + A build stage that takes the source code and scans it on a remote + FOSSOLOGY server in order to produce an SPDX document. + +
+
+ + + -- cgit v1.2.3-54-g00ecf