diff options
Diffstat (limited to 'yocto-poky/documentation/ref-manual/ref-tasks.xml')
| -rw-r--r-- | yocto-poky/documentation/ref-manual/ref-tasks.xml | 131 |
1 files changed, 119 insertions, 12 deletions
diff --git a/yocto-poky/documentation/ref-manual/ref-tasks.xml b/yocto-poky/documentation/ref-manual/ref-tasks.xml index 21403c072..c46debb55 100644 --- a/yocto-poky/documentation/ref-manual/ref-tasks.xml +++ b/yocto-poky/documentation/ref-manual/ref-tasks.xml @@ -31,6 +31,36 @@ </para> </section> + <section id='ref-tasks-checkpkg'> + <title><filename>do_checkpkg</filename></title> + + <para> + Provides information about the recipe including its upstream + version and status. + The upstream version and status reveals whether or not a version + of the recipe exists upstream and a status of not updated, updated, + or unknown. + </para> + + <para> + The <filename>checkpkg</filename> task is included as part of the + <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> + class. + </para> + + <para> + To build the <filename>checkpkg</filename> task, use the + <filename>bitbake</filename> command with the "-c" option and + task name: + <literallayout class='monospaced'> + $ bitbake core-image-minimal -c checkpkg + </literallayout> + By default, the results are stored in + <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> + (e.g. <filename>$BUILD_DIR/tmp/log</filename>). + </para> + </section> + <section id='ref-tasks-compile'> <title><filename>do_compile</filename></title> @@ -87,6 +117,32 @@ </para> </section> + <section id='ref-tasks-distrodata'> + <title><filename>do_distrodata</filename></title> + + <para> + Provides information about the recipe. + </para> + + <para> + The <filename>distrodata</filename> task is included as part of the + <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> + class. + </para> + + <para> + To build the <filename>distrodata</filename> task, use the + <filename>bitbake</filename> command with the "-c" option and + task name: + <literallayout class='monospaced'> + $ bitbake core-image-minimal -c distrodata + </literallayout> + By default, the results are stored in + <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> + (e.g. <filename>$BUILD_DIR/tmp/log</filename>). + </para> + </section> + <section id='ref-tasks-fetch'> <title><filename>do_fetch</filename></title> @@ -99,6 +155,60 @@ </para> </section> + <section id='ref-tasks-image'> + <title><filename>do_image</filename></title> + + <para> + Starts the image generation process. + The <filename>do_image</filename> task runs after the + OpenEmbedded build system has run the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task during which packages are identified for installation into + the image and the root filesystem is created, complete with + post-processing. + </para> + + <para> + The <filename>do_image</filename> task performs pre-processing + on the image through the + <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> + and dynamically generates supporting + <filename>do_image_*</filename> tasks as needed. + </para> + + <para> + For more information on image creation, see the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> + </section> + + <section id='ref-tasks-image-complete'> + <title><filename>do_image_complete</filename></title> + + <para> + Completes the image generation process. + The <filename>do_image_complete</filename> task runs after the + OpenEmbedded build system has run the + <link linkend='ref-tasks-rootfs'><filename>do_image</filename></link> + task during which image pre-processing occurs and through + dynamically generated <filename>do_image_*</filename> tasks the + image is constructed. + </para> + + <para> + The <filename>do_image_complete</filename> task performs + post-processing on the image through the + <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link>. + </para> + + <para> + For more information on image creation, see the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> + </section> + <section id='ref-tasks-install'> <title><filename>do_install</filename></title> @@ -239,10 +349,16 @@ <title><filename>do_populate_sysroot</filename></title> <para> - Copies a subset of files installed by the + Copies a subset of the files installed by the <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task into the sysroot in order to make them available to other - recipes. + task into the sysroot to make them available to other recipes. + Files that would typically not be needed by other recipes at build + time are skipped. + Skipped files include files installed into + <filename>/etc.</filename> + For information on what files are copied, see the + <link linkend='ref-classes-staging'><filename>staging</filename></link> + class. </para> <para> @@ -700,15 +816,6 @@ The following sections describe miscellaneous tasks. </para> - <section id='ref-tasks-generate_qt_config_file'> - <title><filename>do_generate_qt_config_file</filename></title> - - <para> - Writes a <filename>qt.conf</filename> configuration - file used for building a Qt-based application. - </para> - </section> - <section id='ref-tasks-spdx'> <title><filename>do_spdx</filename></title> |