blob: 7a664cc6c0ac2b3868c609e0c94a806edc380559 [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002
3*****
4Tasks
5*****
6
7Tasks are units of execution for BitBake. Recipes (``.bb`` files) use
8tasks to complete configuring, compiling, and packaging software. This
9chapter provides a reference of the tasks defined in the OpenEmbedded
10build system.
11
12Normal Recipe Build Tasks
13=========================
14
15The following sections describe normal tasks associated with building a
16recipe. For more information on tasks and dependencies, see the
Patrick Williams213cb262021-08-07 19:21:33 -050017":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
Andrew Geisslerc9f78652020-09-18 14:11:35 -050019BitBake User Manual.
20
21.. _ref-tasks-build:
22
23``do_build``
24------------
25
26The default task for all recipes. This task depends on all other normal
27tasks required to build a recipe.
28
29.. _ref-tasks-compile:
30
31``do_compile``
32--------------
33
34Compiles the source code. This task runs with the current working
35directory set to ``${``\ :term:`B`\ ``}``.
36
37The default behavior of this task is to run the ``oe_runmake`` function
38if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found.
Patrick Williams2194f502022-10-16 14:26:09 -050039If no such file is found, the :ref:`ref-tasks-compile` task does nothing.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050040
41.. _ref-tasks-compile_ptest_base:
42
43``do_compile_ptest_base``
44-------------------------
45
46Compiles the runtime test suite included in the software being built.
47
48.. _ref-tasks-configure:
49
50``do_configure``
51----------------
52
53Configures the source by enabling and disabling any build-time and
54configuration options for the software being built. The task runs with
55the current working directory set to ``${``\ :term:`B`\ ``}``.
56
57The default behavior of this task is to run ``oe_runmake clean`` if a
58makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
59:term:`CLEANBROKEN` is not set to "1". If no such
Andrew Geissler09036742021-06-25 14:25:14 -050060file is found or the :term:`CLEANBROKEN` variable is set to "1", the
Patrick Williams2194f502022-10-16 14:26:09 -050061:ref:`ref-tasks-configure` task does nothing.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050062
63.. _ref-tasks-configure_ptest_base:
64
65``do_configure_ptest_base``
66---------------------------
67
68Configures the runtime test suite included in the software being built.
69
70.. _ref-tasks-deploy:
71
72``do_deploy``
73-------------
74
75Writes output files that are to be deployed to
76``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The
77task runs with the current working directory set to
78``${``\ :term:`B`\ ``}``.
79
80Recipes implementing this task should inherit the
Andrew Geissler517393d2023-01-13 08:55:19 -060081:ref:`ref-classes-deploy` class and should write the output
Andrew Geisslerc9f78652020-09-18 14:11:35 -050082to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be
Andrew Geissler517393d2023-01-13 08:55:19 -060083confused with ``${DEPLOY_DIR}``. The :ref:`ref-classes-deploy` class sets up
Patrick Williams2194f502022-10-16 14:26:09 -050084:ref:`ref-tasks-deploy` as a shared state (sstate) task that can be accelerated
Andrew Geisslerc9f78652020-09-18 14:11:35 -050085through sstate use. The sstate mechanism takes care of copying the
86output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
87
88.. note::
89
Andrew Geissler4c19ea12020-10-27 13:52:24 -050090 Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes
91 the sstate mechanism to malfunction.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050092
Patrick Williams2194f502022-10-16 14:26:09 -050093The :ref:`ref-tasks-deploy` task is not added as a task by default and
Andrew Geisslerc9f78652020-09-18 14:11:35 -050094consequently needs to be added manually. If you want the task to run
95after :ref:`ref-tasks-compile`, you can add it by doing
Andrew Geisslerc926e172021-05-07 16:11:35 -050096the following::
Andrew Geissler4c19ea12020-10-27 13:52:24 -050097
98 addtask deploy after do_compile
99
Patrick Williams2194f502022-10-16 14:26:09 -0500100Adding :ref:`ref-tasks-deploy` after other tasks works the same way.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500101
102.. note::
103
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500104 You do not need to add ``before do_build`` to the ``addtask`` command
Andrew Geissler517393d2023-01-13 08:55:19 -0600105 (though it is harmless), because the :ref:`ref-classes-base` class contains the following::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500106
107 do_build[recrdeptask] += "do_deploy"
108
109
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500110 See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
111 section in the BitBake User Manual for more information.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500112
Patrick Williams2194f502022-10-16 14:26:09 -0500113If the :ref:`ref-tasks-deploy` task re-executes, any previous output is removed
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500114(i.e. "cleaned").
115
116.. _ref-tasks-fetch:
117
118``do_fetch``
119------------
120
121Fetches the source code. This task uses the
122:term:`SRC_URI` variable and the argument's prefix to
Andrew Geissler09209ee2020-12-13 08:44:15 -0600123determine the correct :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500124module.
125
126.. _ref-tasks-image:
127
128``do_image``
129------------
130
Patrick Williams2194f502022-10-16 14:26:09 -0500131Starts the image generation process. The :ref:`ref-tasks-image` task runs after
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500132the OpenEmbedded build system has run the
133:ref:`ref-tasks-rootfs` task during which packages are
134identified for installation into the image and the root filesystem is
135created, complete with post-processing.
136
Patrick Williams2194f502022-10-16 14:26:09 -0500137The :ref:`ref-tasks-image` task performs pre-processing on the image through the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500138:term:`IMAGE_PREPROCESS_COMMAND` and
Patrick Williams2194f502022-10-16 14:26:09 -0500139dynamically generates supporting :ref:`do_image_* <ref-tasks-image>` tasks as needed.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500140
Andrew Geissler09209ee2020-12-13 08:44:15 -0600141For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500142section in the Yocto Project Overview and Concepts Manual.
143
144.. _ref-tasks-image-complete:
145
146``do_image_complete``
147---------------------
148
Patrick Williams2194f502022-10-16 14:26:09 -0500149Completes the image generation process. The :ref:`do_image_complete <ref-tasks-image-complete>` task
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500150runs after the OpenEmbedded build system has run the
151:ref:`ref-tasks-image` task during which image
Patrick Williams2194f502022-10-16 14:26:09 -0500152pre-processing occurs and through dynamically generated :ref:`do_image_* <ref-tasks-image>`
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500153tasks the image is constructed.
154
Patrick Williams2194f502022-10-16 14:26:09 -0500155The :ref:`do_image_complete <ref-tasks-image-complete>` task performs post-processing on the image
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500156through the
157:term:`IMAGE_POSTPROCESS_COMMAND`.
158
159For more information on image creation, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600160":ref:`overview-manual/concepts:image generation`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500161section in the Yocto Project Overview and Concepts Manual.
162
163.. _ref-tasks-install:
164
165``do_install``
166--------------
167
168Copies files that are to be packaged into the holding area
169``${``\ :term:`D`\ ``}``. This task runs with the current
170working directory set to ``${``\ :term:`B`\ ``}``, which is the
Patrick Williams2194f502022-10-16 14:26:09 -0500171compilation directory. The :ref:`ref-tasks-install` task, as well as other tasks
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500172that either directly or indirectly depend on the installed files (e.g.
Patrick Williams2194f502022-10-16 14:26:09 -0500173:ref:`ref-tasks-package`, :ref:`do_package_write_* <ref-tasks-package_write_deb>`, and
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500174:ref:`ref-tasks-rootfs`), run under
Andrew Geissler09209ee2020-12-13 08:44:15 -0600175:ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500176
177.. note::
178
179 When installing files, be careful not to set the owner and group IDs
180 of the installed files to unintended values. Some methods of copying
181 files, notably when using the recursive ``cp`` command, can preserve
182 the UID and/or GID of the original file, which is usually not what
183 you want. The ``host-user-contaminated`` QA check checks for files
184 that probably have the wrong ownership.
185
186 Safe methods for installing files include the following:
187
188 - The ``install`` utility. This utility is the preferred method.
189
Patrick Williams45852732022-04-02 08:58:32 -0500190 - The ``cp`` command with the ``--no-preserve=ownership`` option.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500191
Patrick Williams45852732022-04-02 08:58:32 -0500192 - The ``tar`` command with the ``--no-same-owner`` option. See the
Patrick Williams975a06f2022-10-21 14:42:47 -0500193 ``bin_package.bbclass`` file in the ``meta/classes-recipe``
194 subdirectory of the :term:`Source Directory` for an example.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500195
196.. _ref-tasks-install_ptest_base:
197
198``do_install_ptest_base``
199-------------------------
200
201Copies the runtime test suite files from the compilation directory to a
202holding area.
203
204.. _ref-tasks-package:
205
206``do_package``
207--------------
208
209Analyzes the content of the holding area
210``${``\ :term:`D`\ ``}`` and splits the content into subsets
211based on available packages and files. This task makes use of the
212:term:`PACKAGES` and :term:`FILES`
213variables.
214
Patrick Williams2194f502022-10-16 14:26:09 -0500215The :ref:`ref-tasks-package` task, in conjunction with the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500216:ref:`ref-tasks-packagedata` task, also saves some
217important package metadata. For additional information, see the
218:term:`PKGDESTWORK` variable and the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600219":ref:`overview-manual/concepts:automatically added runtime dependencies`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500220section in the Yocto Project Overview and Concepts Manual.
221
222.. _ref-tasks-package_qa:
223
224``do_package_qa``
225-----------------
226
227Runs QA checks on packaged files. For more information on these checks,
Andrew Geissler517393d2023-01-13 08:55:19 -0600228see the :ref:`ref-classes-insane` class.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500229
230.. _ref-tasks-package_write_deb:
231
232``do_package_write_deb``
233------------------------
234
235Creates Debian packages (i.e. ``*.deb`` files) and places them in the
236``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
237the package feeds area. For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600238":ref:`overview-manual/concepts:package feeds`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500239the Yocto Project Overview and Concepts Manual.
240
241.. _ref-tasks-package_write_ipk:
242
243``do_package_write_ipk``
244------------------------
245
246Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
247``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
248the package feeds area. For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600249":ref:`overview-manual/concepts:package feeds`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500250the Yocto Project Overview and Concepts Manual.
251
252.. _ref-tasks-package_write_rpm:
253
254``do_package_write_rpm``
255------------------------
256
257Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
258``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
259the package feeds area. For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600260":ref:`overview-manual/concepts:package feeds`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500261the Yocto Project Overview and Concepts Manual.
262
263.. _ref-tasks-package_write_tar:
264
265``do_package_write_tar``
266------------------------
267
268Creates tarballs and places them in the
269``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
270the package feeds area. For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600271":ref:`overview-manual/concepts:package feeds`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500272the Yocto Project Overview and Concepts Manual.
273
274.. _ref-tasks-packagedata:
275
276``do_packagedata``
277------------------
278
279Saves package metadata generated by the
280:ref:`ref-tasks-package` task in
281:term:`PKGDATA_DIR` to make it available globally.
282
283.. _ref-tasks-patch:
284
285``do_patch``
286------------
287
288Locates patch files and applies them to the source code.
289
290After fetching and unpacking source files, the build system uses the
291recipe's :term:`SRC_URI` statements
292to locate and apply patch files to the source code.
293
294.. note::
295
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500296 The build system uses the :term:`FILESPATH` variable to determine the
297 default set of directories when searching for patches.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500298
299Patch files, by default, are ``*.patch`` and ``*.diff`` files created
300and kept in a subdirectory of the directory holding the recipe file. For
301example, consider the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600302:yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>`
Andrew Geisslerc926e172021-05-07 16:11:35 -0500303recipe from the OE-Core layer (i.e. ``poky/meta``)::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500304
305 poky/meta/recipes-connectivity/bluez5
306
Andrew Geisslerc926e172021-05-07 16:11:35 -0500307This recipe has two patch files located here::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500308
309 poky/meta/recipes-connectivity/bluez5/bluez5
310
Andrew Geissler09036742021-06-25 14:25:14 -0500311In the ``bluez5`` recipe, the :term:`SRC_URI` statements point to the source
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500312and patch files needed to build the package.
313
314.. note::
315
Andrew Geissler09036742021-06-25 14:25:14 -0500316 In the case for the ``bluez5_5.48.bb`` recipe, the :term:`SRC_URI` statements
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500317 are from an include file ``bluez5.inc``.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500318
319As mentioned earlier, the build system treats files whose file types are
320``.patch`` and ``.diff`` as patch files. However, you can use the
Andrew Geissler09036742021-06-25 14:25:14 -0500321"apply=yes" parameter with the :term:`SRC_URI` statement to indicate any
Andrew Geisslerc926e172021-05-07 16:11:35 -0500322file as a patch file::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500323
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500324 SRC_URI = " \
325 git://path_to_repo/some_package \
326 file://file;apply=yes \
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500327 "
328
Andrew Geissler595f6302022-01-24 19:11:47 +0000329Conversely, if you have a file whose file type is ``.patch`` or ``.diff``
Patrick Williams2194f502022-10-16 14:26:09 -0500330and you want to exclude it so that the :ref:`ref-tasks-patch` task does not apply
Andrew Geissler595f6302022-01-24 19:11:47 +0000331it during the patch phase, you can use the "apply=no" parameter with the
Andrew Geissler09036742021-06-25 14:25:14 -0500332:term:`SRC_URI` statement::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500333
334 SRC_URI = " \
335 git://path_to_repo/some_package \
Andrew Geissler595f6302022-01-24 19:11:47 +0000336 file://file1.patch \
337 file://file2.patch;apply=no \
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500338 "
339
Andrew Geissler595f6302022-01-24 19:11:47 +0000340In the previous example ``file1.patch`` would be applied as a patch by default
341while ``file2.patch`` would not be applied.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500342
343You can find out more about the patching process in the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600344":ref:`overview-manual/concepts:patching`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500345the Yocto Project Overview and Concepts Manual and the
Andrew Geissler517393d2023-01-13 08:55:19 -0600346":ref:`dev-manual/new-recipe:patching code`" section in the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500347Yocto Project Development Tasks Manual.
348
349.. _ref-tasks-populate_lic:
350
351``do_populate_lic``
352-------------------
353
354Writes license information for the recipe that is collected later when
355the image is constructed.
356
357.. _ref-tasks-populate_sdk:
358
359``do_populate_sdk``
360-------------------
361
362Creates the file and directory structure for an installable SDK. See the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600363":ref:`overview-manual/concepts:sdk generation`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500364section in the Yocto Project Overview and Concepts Manual for more
365information.
366
367.. _ref-tasks-populate_sdk_ext:
368
369``do_populate_sdk_ext``
370-----------------------
371
372Creates the file and directory structure for an installable extensible
Andrew Geissler09209ee2020-12-13 08:44:15 -0600373SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500374section in the Yocto Project Overview and Concepts Manual for more
375information.
376
377
378.. _ref-tasks-populate_sysroot:
379
380``do_populate_sysroot``
381-----------------------
382
383Stages (copies) a subset of the files installed by the
384:ref:`ref-tasks-install` task into the appropriate
385sysroot. For information on how to access these files from other
386recipes, see the :term:`STAGING_DIR* <STAGING_DIR_HOST>` variables.
387Directories that would typically not be needed by other recipes at build
388time (e.g. ``/etc``) are not copied by default.
389
390For information on what directories are copied by default, see the
391:term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables. You can change
392these variables inside your recipe if you need to make additional (or
393fewer) directories available to other recipes at build time.
394
Patrick Williams2194f502022-10-16 14:26:09 -0500395The :ref:`ref-tasks-populate_sysroot` task is a shared state (sstate) task, which
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500396means that the task can be accelerated through sstate use. Realize also
397that if the task is re-executed, any previous output is removed (i.e.
398"cleaned").
399
400.. _ref-tasks-prepare_recipe_sysroot:
401
402``do_prepare_recipe_sysroot``
403-----------------------------
404
405Installs the files into the individual recipe specific sysroots (i.e.
406``recipe-sysroot`` and ``recipe-sysroot-native`` under
407``${``\ :term:`WORKDIR`\ ``}`` based upon the
408dependencies specified by :term:`DEPENDS`). See the
Andrew Geissler517393d2023-01-13 08:55:19 -0600409":ref:`ref-classes-staging`" class for more information.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500410
411.. _ref-tasks-rm_work:
412
413``do_rm_work``
414--------------
415
416Removes work files after the OpenEmbedded build system has finished with
417them. You can learn more by looking at the
Andrew Geissler595f6302022-01-24 19:11:47 +0000418":ref:`ref-classes-rm-work`" section.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500419
420.. _ref-tasks-unpack:
421
422``do_unpack``
423-------------
424
425Unpacks the source code into a working directory pointed to by
426``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
427variable also plays a role in where unpacked source files ultimately
428reside. For more information on how source files are unpacked, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600429":ref:`overview-manual/concepts:source fetching`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500430section in the Yocto Project Overview and Concepts Manual and also see
Andrew Geissler09036742021-06-25 14:25:14 -0500431the :term:`WORKDIR` and :term:`S` variable descriptions.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500432
433Manually Called Tasks
434=====================
435
436These tasks are typically manually triggered (e.g. by using the
437``bitbake -c`` command-line option):
438
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500439``do_checkuri``
440---------------
441
442Validates the :term:`SRC_URI` value.
443
444.. _ref-tasks-clean:
445
446``do_clean``
447------------
448
449Removes all output files for a target from the
Patrick Williams2194f502022-10-16 14:26:09 -0500450:ref:`ref-tasks-unpack` task forward (i.e. :ref:`ref-tasks-unpack`,
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500451:ref:`ref-tasks-configure`,
452:ref:`ref-tasks-compile`,
453:ref:`ref-tasks-install`, and
454:ref:`ref-tasks-package`).
455
Andrew Geisslerc926e172021-05-07 16:11:35 -0500456You can run this task using BitBake as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500457
458 $ bitbake -c clean recipe
459
460Running this task does not remove the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600461:ref:`sstate <overview-manual/concepts:shared state cache>` cache files.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500462Consequently, if no changes have been made and the recipe is rebuilt
463after cleaning, output files are simply restored from the sstate cache.
464If you want to remove the sstate cache files for the recipe, you need to
465use the :ref:`ref-tasks-cleansstate` task instead
466(i.e. ``bitbake -c cleansstate`` recipe).
467
468.. _ref-tasks-cleanall:
469
470``do_cleanall``
471---------------
472
473Removes all output files, shared state
Andrew Geissler09209ee2020-12-13 08:44:15 -0600474(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, and
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500475downloaded source files for a target (i.e. the contents of
Patrick Williams2194f502022-10-16 14:26:09 -0500476:term:`DL_DIR`). Essentially, the :ref:`ref-tasks-cleanall` task is
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500477identical to the :ref:`ref-tasks-cleansstate` task
478with the added removal of downloaded source files.
479
Andrew Geisslerc926e172021-05-07 16:11:35 -0500480You can run this task using BitBake as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500481
482 $ bitbake -c cleanall recipe
483
Patrick Williams2194f502022-10-16 14:26:09 -0500484Typically, you would not normally use the :ref:`ref-tasks-cleanall` task. Do so only
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500485if you want to start fresh with the :ref:`ref-tasks-fetch`
486task.
487
488.. _ref-tasks-cleansstate:
489
490``do_cleansstate``
491------------------
492
493Removes all output files and shared state
Andrew Geissler09209ee2020-12-13 08:44:15 -0600494(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a
Patrick Williams2194f502022-10-16 14:26:09 -0500495target. Essentially, the :ref:`ref-tasks-cleansstate` task is identical to the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500496:ref:`ref-tasks-clean` task with the added removal of
Andrew Geissler09209ee2020-12-13 08:44:15 -0600497shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`)
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500498cache.
499
Andrew Geisslerc926e172021-05-07 16:11:35 -0500500You can run this task using BitBake as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500501
502 $ bitbake -c cleansstate recipe
503
Patrick Williams2194f502022-10-16 14:26:09 -0500504When you run the :ref:`ref-tasks-cleansstate` task, the OpenEmbedded build system
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500505no longer uses any sstate. Consequently, building the recipe from
506scratch is guaranteed.
507
508.. note::
509
Patrick Williams2194f502022-10-16 14:26:09 -0500510 The :ref:`ref-tasks-cleansstate` task cannot remove sstate from a remote sstate
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500511 mirror. If you need to build a target from scratch using remote mirrors, use
Andrew Geisslerc926e172021-05-07 16:11:35 -0500512 the "-f" option as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500513
514 $ bitbake -f -c do_cleansstate target
515
516
Andrew Geisslereff27472021-10-29 15:35:00 -0500517.. _ref-tasks-pydevshell:
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500518
Andrew Geisslereff27472021-10-29 15:35:00 -0500519``do_pydevshell``
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500520-----------------
521
522Starts a shell in which an interactive Python interpreter allows you to
523interact with the BitBake build environment. From within this shell, you
524can directly examine and set bits from the data store and execute
Andrew Geissler517393d2023-01-13 08:55:19 -0600525functions as if within the BitBake environment. See the ":ref:`dev-manual/python-development-shell:using a Python development shell`" section in
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500526the Yocto Project Development Tasks Manual for more information about
Andrew Geisslereff27472021-10-29 15:35:00 -0500527using ``pydevshell``.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500528
529.. _ref-tasks-devshell:
530
531``do_devshell``
532---------------
533
534Starts a shell whose environment is set up for development, debugging,
Andrew Geissler517393d2023-01-13 08:55:19 -0600535or both. See the ":ref:`dev-manual/development-shell:using a development shell`" section in the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500536Yocto Project Development Tasks Manual for more information about using
537``devshell``.
538
539.. _ref-tasks-listtasks:
540
541``do_listtasks``
542----------------
543
544Lists all defined tasks for a target.
545
546.. _ref-tasks-package_index:
547
548``do_package_index``
549--------------------
550
Andrew Geissler09209ee2020-12-13 08:44:15 -0600551Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500552
553.. note::
554
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500555 This task is not triggered with the ``bitbake -c`` command-line option as
556 are the other tasks in this section. Because this task is specifically for
557 the ``package-index`` recipe, you run it using ``bitbake package-index``.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500558
559Image-Related Tasks
560===================
561
562The following tasks are applicable to image recipes.
563
564.. _ref-tasks-bootimg:
565
566``do_bootimg``
567--------------
568
569Creates a bootable live image. See the
570:term:`IMAGE_FSTYPES` variable for additional
571information on live image types.
572
573.. _ref-tasks-bundle_initramfs:
574
575``do_bundle_initramfs``
576-----------------------
577
Patrick Williams2194f502022-10-16 14:26:09 -0500578Combines an :term:`Initramfs` image and kernel together to
579form a single image.
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500580
581.. _ref-tasks-rootfs:
582
583``do_rootfs``
584-------------
585
586Creates the root filesystem (file and directory structure) for an image.
Andrew Geissler09209ee2020-12-13 08:44:15 -0600587See the ":ref:`overview-manual/concepts:image generation`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500588section in the Yocto Project Overview and Concepts Manual for more
589information on how the root filesystem is created.
590
591.. _ref-tasks-testimage:
592
593``do_testimage``
594----------------
595
596Boots an image and performs runtime tests within the image. For
597information on automatically testing images, see the
Andrew Geissler517393d2023-01-13 08:55:19 -0600598":ref:`dev-manual/runtime-testing:performing automated runtime testing`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500599section in the Yocto Project Development Tasks Manual.
600
601.. _ref-tasks-testimage_auto:
602
603``do_testimage_auto``
604---------------------
605
606Boots an image and performs runtime tests within the image immediately
607after it has been built. This task is enabled when you set
608:term:`TESTIMAGE_AUTO` equal to "1".
609
610For information on automatically testing images, see the
Andrew Geissler517393d2023-01-13 08:55:19 -0600611":ref:`dev-manual/runtime-testing:performing automated runtime testing`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500612section in the Yocto Project Development Tasks Manual.
613
614Kernel-Related Tasks
615====================
616
617The following tasks are applicable to kernel recipes. Some of these
618tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
619also applicable to recipes that use Linux kernel style configuration
620such as the BusyBox recipe.
621
622.. _ref-tasks-compile_kernelmodules:
623
624``do_compile_kernelmodules``
625----------------------------
626
627Runs the step that builds the kernel modules (if needed). Building a
628kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and
6292) the modules are built (i.e. ``make modules``).
630
631.. _ref-tasks-diffconfig:
632
633``do_diffconfig``
634-----------------
635
636When invoked by the user, this task creates a file containing the
637differences between the original config as produced by
638:ref:`ref-tasks-kernel_configme` task and the
639changes made by the user with other methods (i.e. using
640(:ref:`ref-tasks-kernel_menuconfig`). Once the
641file of differences is created, it can be used to create a config
642fragment that only contains the differences. You can invoke this task
Andrew Geisslerc926e172021-05-07 16:11:35 -0500643from the command line as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500644
645 $ bitbake linux-yocto -c diffconfig
646
647For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600648":ref:`kernel-dev/common:creating configuration fragments`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500649section in the Yocto Project Linux Kernel Development Manual.
650
651.. _ref-tasks-kernel_checkout:
652
653``do_kernel_checkout``
654----------------------
655
656Converts the newly unpacked kernel source into a form with which the
657OpenEmbedded build system can work. Because the kernel source can be
Patrick Williams2194f502022-10-16 14:26:09 -0500658fetched in several different ways, the :ref:`ref-tasks-kernel_checkout` task makes
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500659sure that subsequent tasks are given a clean working tree copy of the
660kernel with the correct branches checked out.
661
662.. _ref-tasks-kernel_configcheck:
663
664``do_kernel_configcheck``
665-------------------------
666
667Validates the configuration produced by the
668:ref:`ref-tasks-kernel_menuconfig` task. The
Patrick Williams2194f502022-10-16 14:26:09 -0500669:ref:`ref-tasks-kernel_configcheck` task produces warnings when a requested
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500670configuration does not appear in the final ``.config`` file or when you
671override a policy configuration in a hardware configuration fragment.
672You can run this task explicitly and view the output by using the
Andrew Geisslerc926e172021-05-07 16:11:35 -0500673following command::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500674
675 $ bitbake linux-yocto -c kernel_configcheck -f
676
677For more information, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600678":ref:`kernel-dev/common:validating configuration`"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500679section in the Yocto Project Linux Kernel Development Manual.
680
681.. _ref-tasks-kernel_configme:
682
683``do_kernel_configme``
684----------------------
685
686After the kernel is patched by the :ref:`ref-tasks-patch`
Patrick Williams2194f502022-10-16 14:26:09 -0500687task, the :ref:`ref-tasks-kernel_configme` task assembles and merges all the
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500688kernel config fragments into a merged configuration that can then be
689passed to the kernel configuration phase proper. This is also the time
690during which user-specified defconfigs are applied if present, and where
691configuration modes such as ``--allnoconfig`` are applied.
692
693.. _ref-tasks-kernel_menuconfig:
694
695``do_kernel_menuconfig``
696------------------------
697
698Invoked by the user to manipulate the ``.config`` file used to build a
699linux-yocto recipe. This task starts the Linux kernel configuration
700tool, which you then use to modify the kernel configuration.
701
702.. note::
703
Andrew Geisslerc926e172021-05-07 16:11:35 -0500704 You can also invoke this tool from the command line as follows::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500705
706 $ bitbake linux-yocto -c menuconfig
707
708
Andrew Geissler09209ee2020-12-13 08:44:15 -0600709See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500710section in the Yocto Project Linux Kernel Development Manual for more
711information on this configuration tool.
712
713.. _ref-tasks-kernel_metadata:
714
715``do_kernel_metadata``
716----------------------
717
718Collects all the features required for a given kernel build, whether the
719features come from :term:`SRC_URI` or from Git
Patrick Williams2194f502022-10-16 14:26:09 -0500720repositories. After collection, the :ref:`ref-tasks-kernel_metadata` task
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500721processes the features into a series of config fragments and patches,
722which can then be applied by subsequent tasks such as
723:ref:`ref-tasks-patch` and
724:ref:`ref-tasks-kernel_configme`.
725
726.. _ref-tasks-menuconfig:
727
728``do_menuconfig``
729-----------------
730
731Runs ``make menuconfig`` for the kernel. For information on
732``menuconfig``, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -0600733":ref:`kernel-dev/common:using \`\`menuconfig\`\``"
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500734section in the Yocto Project Linux Kernel Development Manual.
735
736.. _ref-tasks-savedefconfig:
737
738``do_savedefconfig``
739--------------------
740
741When invoked by the user, creates a defconfig file that can be used
742instead of the default defconfig. The saved defconfig contains the
743differences between the default defconfig and the changes made by the
744user using other methods (i.e. the
745:ref:`ref-tasks-kernel_menuconfig` task. You
Andrew Geisslerc926e172021-05-07 16:11:35 -0500746can invoke the task using the following command::
Andrew Geisslerc9f78652020-09-18 14:11:35 -0500747
748 $ bitbake linux-yocto -c savedefconfig
749
750.. _ref-tasks-shared_workdir:
751
752``do_shared_workdir``
753---------------------
754
755After the kernel has been compiled but before the kernel modules have
756been compiled, this task copies files required for module builds and
757which are generated from the kernel build into the shared work
758directory. With these copies successfully copied, the
759:ref:`ref-tasks-compile_kernelmodules` task
760can successfully build the kernel modules in the next step of the build.
761
762.. _ref-tasks-sizecheck:
763
764``do_sizecheck``
765----------------
766
767After the kernel has been built, this task checks the size of the
768stripped kernel image against
769:term:`KERNEL_IMAGE_MAXSIZE`. If that
770variable was set and the size of the stripped kernel exceeds that size,
771the kernel build produces a warning to that effect.
772
773.. _ref-tasks-strip:
774
775``do_strip``
776------------
777
778If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips
779the sections named in that variable from ``vmlinux``. This stripping is
780typically used to remove nonessential sections such as ``.comment``
781sections from a size-sensitive configuration.
782
783.. _ref-tasks-validate_branches:
784
785``do_validate_branches``
786------------------------
787
788After the kernel is unpacked but before it is patched, this task makes
789sure that the machine and metadata branches as specified by the
790:term:`SRCREV` variables actually exist on the specified
William A. Kennington IIIac69b482021-06-02 12:28:27 -0700791branches. Otherwise, if :term:`AUTOREV` is not being used, the
Patrick Williams2194f502022-10-16 14:26:09 -0500792:ref:`ref-tasks-validate_branches` task fails during the build.