documentation/ref-manual/tasks.rst

4 Tasks  title
7 Tasks are units of execution for BitBake. Recipes (``.bb`` files) use
8 tasks to complete configuring, compiling, and packaging software. This
9 chapter provides a reference of the tasks defined in the OpenEmbedded
12 Normal Recipe Build Tasks
15 The following sections describe normal tasks associated with building a
16 recipe. For more information on tasks and dependencies, see the
17 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and
21 .. _ref-tasks-build:
27 tasks required to build a recipe.
29 .. _ref-tasks-compile:
41 .. _ref-tasks-compile_ptest_base:
48 .. _ref-tasks-configure:
63 .. _ref-tasks-configure_ptest_base:
70 .. _ref-tasks-deploy:
95 after :ref:`ref-tasks-compile`, you can add it by doing
100 Adding ``do_deploy`` after other tasks works the same way.
116 .. _ref-tasks-fetch:
126 .. _ref-tasks-image:
133 :ref:`ref-tasks-rootfs` task during which packages are
139 dynamically generates supporting ``do_image_*`` tasks as needed.
144 .. _ref-tasks-image-complete:
151 :ref:`ref-tasks-image` task during which image
153 tasks the image is constructed.
163 .. _ref-tasks-install:
171 compilation directory. The ``do_install`` task, as well as other tasks
173 :ref:`ref-tasks-package`, ``do_package_write_*``, and
174 :ref:`ref-tasks-rootfs`), run under
196 .. _ref-tasks-install_ptest_base:
204 .. _ref-tasks-package:
216 :ref:`ref-tasks-packagedata` task, also saves some
222 .. _ref-tasks-package_qa:
230 .. _ref-tasks-package_write_deb:
241 .. _ref-tasks-package_write_ipk:
252 .. _ref-tasks-package_write_rpm:
263 .. _ref-tasks-package_write_tar:
274 .. _ref-tasks-packagedata:
280 :ref:`ref-tasks-package` task in
283 .. _ref-tasks-patch:
346 ":ref:`dev-manual/common-tasks:patching code`" section in the
347 Yocto Project Development Tasks Manual.
349 .. _ref-tasks-populate_lic:
357 .. _ref-tasks-populate_sdk:
367 .. _ref-tasks-populate_sdk_ext:
378 .. _ref-tasks-populate_sysroot:
384 :ref:`ref-tasks-install` task into the appropriate
400 .. _ref-tasks-prepare_recipe_sysroot:
411 .. _ref-tasks-rm_work:
420 .. _ref-tasks-unpack:
433 Manually Called Tasks
436 These tasks are typically manually triggered (e.g. by using the
444 .. _ref-tasks-clean:
450 :ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``,
451 :ref:`ref-tasks-configure`,
452 :ref:`ref-tasks-compile`,
453 :ref:`ref-tasks-install`, and
454 :ref:`ref-tasks-package`).
465 use the :ref:`ref-tasks-cleansstate` task instead
468 .. _ref-tasks-cleanall:
477 identical to the :ref:`ref-tasks-cleansstate` task
485 if you want to start fresh with the :ref:`ref-tasks-fetch`
488 .. _ref-tasks-cleansstate:
496 :ref:`ref-tasks-clean` task with the added removal of
517 .. _ref-tasks-pydevshell:
525 functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a pyth…
526 the Yocto Project Development Tasks Manual for more information about
529 .. _ref-tasks-devshell:
535 or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the
536 Yocto Project Development Tasks Manual for more information about using
539 .. _ref-tasks-listtasks:
544 Lists all defined tasks for a target.
546 .. _ref-tasks-package_index:
556    are the other tasks in this section. Because this task is specifically for
559 Image-Related Tasks
562 The following tasks are applicable to image recipes.
564 .. _ref-tasks-bootimg:
573 .. _ref-tasks-bundle_initramfs:
583 .. _ref-tasks-rootfs:
593 .. _ref-tasks-testimage:
600 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
601 section in the Yocto Project Development Tasks Manual.
603 .. _ref-tasks-testimage_auto:
613 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
614 section in the Yocto Project Development Tasks Manual.
616 Kernel-Related Tasks
619 The following tasks are applicable to kernel recipes. Some of these
620 tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
624 .. _ref-tasks-compile_kernelmodules:
633 .. _ref-tasks-diffconfig:
640 :ref:`ref-tasks-kernel_configme` task and the
642 (:ref:`ref-tasks-kernel_menuconfig`). Once the
653 .. _ref-tasks-kernel_checkout:
661 sure that subsequent tasks are given a clean working tree copy of the
664 .. _ref-tasks-kernel_configcheck:
670 :ref:`ref-tasks-kernel_menuconfig` task. The
683 .. _ref-tasks-kernel_configme:
688 After the kernel is patched by the :ref:`ref-tasks-patch`
695 .. _ref-tasks-kernel_menuconfig:
715 .. _ref-tasks-kernel_metadata:
724 which can then be applied by subsequent tasks such as
725 :ref:`ref-tasks-patch` and
726 :ref:`ref-tasks-kernel_configme`.
728 .. _ref-tasks-menuconfig:
738 .. _ref-tasks-savedefconfig:
747 :ref:`ref-tasks-kernel_menuconfig` task. You
752 .. _ref-tasks-shared_workdir:
761 :ref:`ref-tasks-compile_kernelmodules` task
764 .. _ref-tasks-sizecheck:
775 .. _ref-tasks-strip:
785 .. _ref-tasks-validate_branches: