do_build
- Default task for a recipe - depends on all other normal tasks
- required to 'build' a recipe.
+ The default task for all recipes.
+ This task depends on all other normal tasks
+ required to build a recipe.
@@ -34,7 +35,9 @@
do_compile
- Compiles the source in the compilation directory.
+ Compiles the source in the compilation directory, which is pointed
+ to by the
+ B variable.
@@ -69,7 +72,10 @@
do_deploy
- Writes deployable output files to the deploy directory.
+ Writes output files that are to be deployed to the deploy
+ directory, which is defined by the
+ DEPLOYDIR
+ variable.
@@ -78,6 +84,12 @@
Fetches the source code.
+ This task uses the
+ SRC_URI
+ variable and the argument's prefix to determine the correct
+ fetcher module.
+ Unpacked source files reside in the
+ S directory.
@@ -85,7 +97,11 @@
do_install
- Copies files from the compilation directory to a holding area.
+ Copies files from the compilation directory, which is defined by
+ the
+ B variable,
+ to a holding area defined by the
+ D variable.
@@ -111,7 +127,9 @@
do_package_index
- Creates or updates the index in the Package Feed area.
+ Creates or updates the index in the
+ Package Feeds
+ area.
@@ -119,7 +137,8 @@
do_package_write_deb
- Creates the actual DEB packages and places them in the Package Feed
+ Creates the actual DEB packages and places them in the
+ Package Feeds
area.
@@ -128,7 +147,8 @@
do_package_write_ipk
- Creates the actual IPK packages and places them in the Package Feed
+ Creates the actual IPK packages and places them in the
+ Package Feeds
area.
@@ -137,7 +157,8 @@
do_package_write_rpm
- Creates the actual RPM packages and places them in the Package Feed
+ Creates the actual RPM packages and places them in the
+ Package Feeds
area.
@@ -146,8 +167,9 @@
do_package_write_tar
- Creates tar archives for packages and places them in the Package
- Feed area.
+ Creates tar archives for packages and places them in the
+ Package Feeds
+ area.
@@ -165,6 +187,9 @@
Locates patch files and applies them to the source code.
+ See the
+ "Patching"
+ section for more information.
@@ -182,6 +207,9 @@
Creates the file and directory structure for an installable SDK.
+ See the
+ "SDK Generation"
+ section for more information.
@@ -200,7 +228,11 @@
do_rm_work
- Removes work files after the build system has finished with them.
+ Removes work files after the OpenEmbedded build system has
+ finished with them.
+ You can learn more by looking at the
+ "rm_work.bbclass"
+ section.
@@ -218,6 +250,9 @@
Unpacks the source code into a working directory.
+ For more information on fetching and unpacking source files, see the
+ "Source Fetching"
+ section.
@@ -234,7 +269,9 @@
do_checkuri
- Validates the SRC_URI value.
+ Validates the
+ SRC_URI
+ value.
@@ -242,8 +279,9 @@
do_checkuriall
- Validates the SRC_URI value for all recipes required to build a
- target.
+ Validates the
+ SRC_URI
+ value for all recipes required to build a target.
@@ -259,8 +297,9 @@
do_cleanall
- Removes all output files, shared state cache, and downloaded source
- files for a target.
+ Removes all output files, shared state
+ (sstate) cache, and
+ downloaded source files for a target.
@@ -268,7 +307,9 @@
do_cleansstate
- Removes all output files and shared state cache for a target.
+ Removes all output files and shared state
+ (sstate)
+ cache for a target.
@@ -284,8 +325,12 @@
do_devshell
- Starts a shell with the environment set up for
- development/debugging.
+ Starts a shell whose environment is set up for
+ development, debugging, or both.
+ See the
+ "Using a Development Shell"
+ section in the Yocto Project Development Manual for more
+ information about using devshell.
@@ -310,6 +355,9 @@
Creates a bootable live image.
+ See the
+ IMAGE_FSTYPES
+ variable for additional information on live image types.
@@ -317,8 +365,11 @@
do_bundle_initramfs
- Combines an initial ramdisk image and kernel together to form
- a single image.
+ Combines an initial RAM disk (initramfs) image and kernel
+ together to form a single image.
+ The
+ CONFIG_INITRAMFS_SOURCE
+ variable has some more information about these types of images.
@@ -328,6 +379,9 @@
Creates the root filesystem (file and directory structure) for an
image.
+ See the
+ "Image Generation"
+ section for more information on how the root filesystem is created.
@@ -352,8 +406,9 @@
do_vmdkimg
- Creates a .vmdk image for use with VMware and compatible virtual
- machine hosts.
+ Creates a .vmdk image for use with
+ VMware
+ and compatible virtual machine hosts.
@@ -363,10 +418,10 @@
The following tasks are applicable to kernel recipes.
- Some of them (e.g. the
+ Some of these tasks (e.g. the
do_menuconfig
task) are also applicable to recipes that use
- Linux kernel style configuration (e.g. BusyBox).
+ Linux kernel style configuration such as the BusyBox recipe.
@@ -415,7 +470,8 @@
do_kernel_link_vmlinux
- Creates a symbolic link in arch/$arch/boot for vmlinux kernel
+ Creates a symbolic link in
+ arch/$arch/boot for vmlinux kernel
images.
@@ -424,7 +480,10 @@
do_menuconfig
- Runs 'make menuconfig' for the kernel.
+ Runs make menuconfig for the kernel.
+ For information on menuconfig, see the
+ "Using menuconfig"
+ section in the Yocto Project Development Manual.
@@ -440,8 +499,8 @@
do_sizecheck
- Checks the size of the kernel image against KERNEL_IMAGE_MAXSIZE
- (if set).
+ Checks the size of the kernel image against
+ KERNEL_IMAGE_MAXSIZE when set.
@@ -465,8 +524,10 @@
do_validate_branches
- Ensures that the source/meta branches are on the locations
- specified by their SRCREV values for a linux-yocto style kernel.
+ Ensures that the source, metadata (or both) branches are on the
+ locations specified by their
+ SRCREV
+ values for a linux-yocto style kernel.
@@ -482,7 +543,8 @@
do_generate_qt_config_file
- Writes a qt.conf file for building a Qt-based application.
+ Writes a qt.conf configuration
+ file used for building a Qt-based application.
@@ -492,6 +554,9 @@
A build stage that takes the source code and scans it on a remote
FOSSOLOGY server in order to produce an SPDX document.
+ This task applies only to the
+ spdx
+ class.