documentation/ref-manual/tasks.rst

1 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
17 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and
18 ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the
21 .. _ref-tasks-build:
24 ------------
29 .. _ref-tasks-compile:
32 --------------
41 .. _ref-tasks-compile_ptest_base:
44 -------------------------
48 .. _ref-tasks-configure:
51 ----------------
53 Configures the source by enabling and disabling any build-time and
63 .. _ref-tasks-configure_ptest_base:
66 ---------------------------
70 .. _ref-tasks-deploy:
73 -------------
81 :ref:`deploy <ref-classes-deploy>` class and should write the output
83 confused with ``${DEPLOY_DIR}``. The :ref:`deploy <ref-classes-deploy>` class sets up
95 after :ref:`ref-tasks-compile`, you can add it by doing
105 … (though it is harmless), because the :ref:`base <ref-classes-base>` class contains the following::
110    See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
113 If the ``do_deploy`` task re-executes, any previous output is removed
116 .. _ref-tasks-fetch:
119 ------------
123 determine the correct :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetch…
126 .. _ref-tasks-image:
129 ------------
133 :ref:`ref-tasks-rootfs` task during which packages are
135 created, complete with post-processing.
137 The ``do_image`` task performs pre-processing on the image through the
141 For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
144 .. _ref-tasks-image-complete:
147 ---------------------
151 :ref:`ref-tasks-image` task during which image
152 pre-processing occurs and through dynamically generated ``do_image_*``
155 The ``do_image_complete`` task performs post-processing on the image
160 ":ref:`overview-manual/concepts:image generation`"
163 .. _ref-tasks-install:
166 --------------
168 Copies files that are to be packaged into the holding area
173 :ref:`ref-tasks-package`, ``do_package_write_*``, and
174 :ref:`ref-tasks-rootfs`), run under
175 :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
183    you want. The ``host-user-contaminated`` QA check checks for files
188    -  The ``install`` utility. This utility is the preferred method.
190    -  The ``cp`` command with the ``--no-preserve=ownership`` option.
192    -  The ``tar`` command with the ``--no-same-owner`` option. See the
196 .. _ref-tasks-install_ptest_base:
199 -------------------------
204 .. _ref-tasks-package:
207 --------------
216 :ref:`ref-tasks-packagedata` task, also saves some
219 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
222 .. _ref-tasks-package_qa:
225 -----------------
227 Runs QA checks on packaged files. For more information on these checks,
228 see the :ref:`insane <ref-classes-insane>` class.
230 .. _ref-tasks-package_write_deb:
233 ------------------------
238 ":ref:`overview-manual/concepts:package feeds`" section in
241 .. _ref-tasks-package_write_ipk:
244 ------------------------
249 ":ref:`overview-manual/concepts:package feeds`" section in
252 .. _ref-tasks-package_write_rpm:
255 ------------------------
260 ":ref:`overview-manual/concepts:package feeds`" section in
263 .. _ref-tasks-package_write_tar:
266 ------------------------
271 ":ref:`overview-manual/concepts:package feeds`" section in
274 .. _ref-tasks-packagedata:
277 ------------------
280 :ref:`ref-tasks-package` task in
283 .. _ref-tasks-patch:
286 ------------
302 :yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>`
303 recipe from the OE-Core layer (i.e. ``poky/meta``)::
305    poky/meta/recipes-connectivity/bluez5
309    poky/meta/recipes-connectivity/bluez5/bluez5
344 ":ref:`overview-manual/concepts:patching`" section in
346 ":ref:`dev-manual/common-tasks:patching code`" section in the
349 .. _ref-tasks-populate_lic:
352 -------------------
357 .. _ref-tasks-populate_sdk:
360 -------------------
363 ":ref:`overview-manual/concepts:sdk generation`"
367 .. _ref-tasks-populate_sdk_ext:
370 -----------------------
373 SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
378 .. _ref-tasks-populate_sysroot:
381 -----------------------
384 :ref:`ref-tasks-install` task into the appropriate
397 that if the task is re-executed, any previous output is removed (i.e.
400 .. _ref-tasks-prepare_recipe_sysroot:
403 -----------------------------
406 ``recipe-sysroot`` and ``recipe-sysroot-native`` under
409 ":ref:`staging <ref-classes-staging>`" class for more information.
411 .. _ref-tasks-rm_work:
414 --------------
418 ":ref:`ref-classes-rm-work`" section.
420 .. _ref-tasks-unpack:
423 -------------
429 ":ref:`overview-manual/concepts:source fetching`"
437 ``bitbake -c`` command-line option):
440 ---------------
444 .. _ref-tasks-clean:
447 ------------
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`).
458    $ bitbake -c clean recipe
461 :ref:`sstate <overview-manual/concepts:shared state cache>` cache files.
465 use the :ref:`ref-tasks-cleansstate` task instead
466 (i.e. ``bitbake -c cleansstate`` recipe).
468 .. _ref-tasks-cleanall:
471 ---------------
474 (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, and
477 identical to the :ref:`ref-tasks-cleansstate` task
482    $ bitbake -c cleanall recipe
485 if you want to start fresh with the :ref:`ref-tasks-fetch`
488 .. _ref-tasks-cleansstate:
491 ------------------
494 (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a
496 :ref:`ref-tasks-clean` task with the added removal of
497 shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`)
502    $ bitbake -c cleansstate recipe
512    the "-f" option as follows::
514       $ bitbake -f -c do_cleansstate target
517 .. _ref-tasks-pydevshell:
520 -----------------
525 functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a pyth…
529 .. _ref-tasks-devshell:
532 ---------------
535 or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the
539 .. _ref-tasks-listtasks:
542 ----------------
546 .. _ref-tasks-package_index:
549 --------------------
551 Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area.
555    This task is not triggered with the ``bitbake -c`` command-line option as
557    the ``package-index`` recipe, you run it using ``bitbake package-index``.
559 Image-Related Tasks
564 .. _ref-tasks-bootimg:
567 --------------
573 .. _ref-tasks-bundle_initramfs:
576 -----------------------
583 .. _ref-tasks-rootfs:
586 -------------
589 See the ":ref:`overview-manual/concepts:image generation`"
593 .. _ref-tasks-testimage:
596 ----------------
600 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
603 .. _ref-tasks-testimage_auto:
606 ---------------------
613 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
616 Kernel-Related Tasks
620 tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
624 .. _ref-tasks-compile_kernelmodules:
627 ----------------------------
633 .. _ref-tasks-diffconfig:
636 -----------------
640 :ref:`ref-tasks-kernel_configme` task and the
642 (:ref:`ref-tasks-kernel_menuconfig`). Once the
647    $ bitbake linux-yocto -c diffconfig
650 ":ref:`kernel-dev/common:creating configuration fragments`"
653 .. _ref-tasks-kernel_checkout:
656 ----------------------
664 .. _ref-tasks-kernel_configcheck:
667 -------------------------
670 :ref:`ref-tasks-kernel_menuconfig` task. The
677    $ bitbake linux-yocto -c kernel_configcheck -f
680 ":ref:`kernel-dev/common:validating configuration`"
683 .. _ref-tasks-kernel_configme:
686 ----------------------
688 After the kernel is patched by the :ref:`ref-tasks-patch`
692 during which user-specified defconfigs are applied if present, and where
693 configuration modes such as ``--allnoconfig`` are applied.
695 .. _ref-tasks-kernel_menuconfig:
698 ------------------------
701 linux-yocto recipe. This task starts the Linux kernel configuration
708            $ bitbake linux-yocto -c menuconfig
711 See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``"
715 .. _ref-tasks-kernel_metadata:
718 ----------------------
725 :ref:`ref-tasks-patch` and
726 :ref:`ref-tasks-kernel_configme`.
728 .. _ref-tasks-menuconfig:
731 -----------------
735 ":ref:`kernel-dev/common:using \`\`menuconfig\`\``"
738 .. _ref-tasks-savedefconfig:
741 --------------------
747 :ref:`ref-tasks-kernel_menuconfig` task. You
750    $ bitbake linux-yocto -c savedefconfig
752 .. _ref-tasks-shared_workdir:
755 ---------------------
761 :ref:`ref-tasks-compile_kernelmodules` task
764 .. _ref-tasks-sizecheck:
767 ----------------
775 .. _ref-tasks-strip:
778 ------------
783 sections from a size-sensitive configuration.
785 .. _ref-tasks-validate_branches:
788 ------------------------