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.
+
+
+
+ do_build
+
+
+ Default task for a recipe - depends on all other normal tasks
+ required to 'build' a recipe.
+
+
+
+
+ do_compile
+
+
+ Compiles the source in the compilation directory.
+
+
+
+
+ do_compile_ptest_base
+
+
+ Compiles the runtime test suite included in the software being
+ built.
+
+
+
+
+ do_configure
+
+
+ Configures the source by enabling and disabling any build-time and
+ configuration options for the software being built.
+
+
+
+
+ do_configure_ptest_base
+
+
+ Configures the runtime test suite included in the software being
+ built.
+
+
+
+
+ do_deploy
+
+
+ Writes deployable output files to the deploy directory.
+
+
+
+
+ do_fetch
+
+
+ Fetches the source code.
+
+
+
+
+ do_install
+
+
+ Copies files from the compilation directory to a holding area.
+
+
+
+
+ do_install_ptest_base
+
+
+ Copies the runtime test suite files from the compilation directory
+ to a holding area.
+
+
+
+
+ do_package
+
+
+ Analyzes the content of the holding area and splits it into subsets
+ based on available packages and files.
+
+
+
+
+ do_package_index
+
+
+ Creates or updates the index in the Package Feed area.
+
+
+
+
+ do_package_write_deb
+
+
+ Creates the actual DEB packages and places them in the Package Feed
+ area.
+
+
+
+
+ do_package_write_ipk
+
+
+ Creates the actual IPK packages and places them in the Package Feed
+ area.
+
+
+
+
+ do_package_write_rpm
+
+
+ Creates the actual RPM packages and places them in the Package Feed
+ area.
+
+
+
+
+ do_package_write_tar
+
+
+ Creates tar archives for packages and places them in the Package
+ Feed area.
+
+
+
+
+ do_packagedata
+
+
+ Creates package metadata used by the build system to generate the
+ final packages.
+
+
+
+
+ do_patch
+
+
+ Locates patch files and applies them to the source code.
+
+
+
+
+ do_populate_lic
+
+
+ Writes license information for the recipe that is collected later
+ when the image is constructed.
+
+
+
+
+ do_populate_sdk
+
+
+ Creates the file and directory structure for an installable SDK.
+
+
+
+
+ do_populate_sysroot
+
+
+ Copies a subset of files installed by do_install into the sysroot
+ in order to make them available to other recipes.
+
+
+
+
+ do_rm_work
+
+
+ Removes work files after the build system has finished with them.
+
+
+
+
+ do_rm_work_all
+
+
+ Top-level task for removing work files after the build system has
+ finished with them.
+
+
+
+
+ do_unpack
+
+
+ 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):
+
+
+
+ do_checkuri
+
+
+ Validates the SRC_URI value.
+
+
+
+
+ do_checkuriall
+
+
+ Validates the SRC_URI value for all recipes required to build a
+ target.
+
+
+
+
+ do_clean
+
+
+ Removes all output files for a target.
+
+
+
+
+ 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_fetchall
+
+
+ Fetches all remote sources required to build a target.
+
+
+
+
+ do_devshell
+
+
+ Starts a shell with the environment set up for
+ development/debugging.
+
+
+
+
+ do_listtasks
+
+
+ Lists all defined tasks for a target.
+
+
+
+
+
+ Image-Related Tasks
+
+
+ The following tasks are applicable to image recipes.
+
+
+
+ do_bootimg
+
+
+ Creates a bootable live image.
+
+
+
+
+ do_bundle_initramfs
+
+
+ Combines an initial ramdisk image and kernel together to form
+ a single image.
+
+
+
+
+ do_rootfs
+
+
+ Creates the root filesystem (file and directory structure) for an
+ image.
+
+
+
+
+ do_testimage
+
+
+ Boots an image and performs runtime tests within the image.
+
+
+
+
+ do_testimage_auto
+
+
+ Boots an image and performs runtime tests within the image
+ immediately after it has been built.
+
+
+
+
+ do_vmdkimg
+
+
+ Creates a .vmdk image for use with VMware and compatible virtual
+ machine hosts.
+
+
+
+
+
+ Kernel-Related Tasks
+
+
+ The following tasks are applicable to kernel recipes. Some of them
+ (for example do_menuconfig) are also applicable to recipes which use
+ Linux kernel style configuration (e.g. busybox).
+
+
+
+ do_compile_kernelmodules
+
+
+ Compiles loadable modules for the Linux kernel.
+
+
+
+
+ do_diffconfig
+
+
+ Compares the old and new config files after running do_menuconfig
+ for the kernel.
+
+
+
+
+ do_kernel_checkout
+
+
+ Checks out source/meta branches for a linux-yocto style kernel.
+
+
+
+
+ do_kernel_configcheck
+
+
+ Validates the kernel configuration for a linux-yocto style kernel.
+
+
+
+
+ do_kernel_configme
+
+
+ Assembles the kernel configuration for a linux-yocto style kernel.
+
+
+
+
+ do_kernel_link_vmlinux
+
+
+ Creates a symbolic link in arch/$arch/boot for vmlinux kernel
+ images.
+
+
+
+
+ do_menuconfig
+
+
+ Runs 'make menuconfig' for the kernel.
+
+
+
+
+ do_savedefconfig
+
+
+ Creates a minimal Linux kernel configuration file.
+
+
+
+
+ do_sizecheck
+
+
+ Checks the size of the kernel image against KERNEL_IMAGE_MAXSIZE
+ (if set).
+
+
+
+
+ do_strip
+
+
+ Strips unneeded sections out of the Linux kernel image.
+
+
+
+
+ do_uboot_mkimage
+
+
+ Creates a uImage file from the kernel for the U-Boot bootloader.
+
+
+
+
+ do_validate_branches
+
+
+ Ensures that the source/meta branches are on the locations
+ specified by their SRCREV values for a linux-yocto style kernel.
+
+
+
+
+
+ Miscellaneous Tasks
+
+
+ The following sections describe miscellaneous tasks.
+
+
+
+ do_generate_qt_config_file
+
+
+ Writes a qt.conf file for building a Qt-based application.
+
+
+
+
+ do_spdx
+
+
+ A build stage that takes the source code and scans it on a remote
+ FOSSOLOGY server in order to produce an SPDX document.
+
+
+
+
+
+