summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-tasks.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-tasks.rst')
-rw-r--r--documentation/ref-manual/ref-tasks.rst126
1 files changed, 63 insertions, 63 deletions
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 1e4b8197a0..aa7c0df552 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -32,7 +32,7 @@ tasks required to build a recipe.
32-------------- 32--------------
33 33
34Compiles the source code. This task runs with the current working 34Compiles the source code. This task runs with the current working
35directory set to ``${``\ ```B`` <#var-B>`__\ ``}``. 35directory set to ``${``\ :term:`B`\ ``}``.
36 36
37The default behavior of this task is to run the ``oe_runmake`` function 37The default behavior of this task is to run the ``oe_runmake`` function
38if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. 38if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found.
@@ -52,11 +52,11 @@ Compiles the runtime test suite included in the software being built.
52 52
53Configures the source by enabling and disabling any build-time and 53Configures the source by enabling and disabling any build-time and
54configuration options for the software being built. The task runs with 54configuration options for the software being built. The task runs with
55the current working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``. 55the current working directory set to ``${``\ :term:`B`\ ``}``.
56 56
57The default behavior of this task is to run ``oe_runmake clean`` if a 57The default behavior of this task is to run ``oe_runmake clean`` if a
58makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and 58makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and
59```CLEANBROKEN`` <#var-CLEANBROKEN>`__ is not set to "1". If no such 59:term:`CLEANBROKEN` is not set to "1". If no such
60file is found or the ``CLEANBROKEN`` variable is set to "1", the 60file is found or the ``CLEANBROKEN`` variable is set to "1", the
61``do_configure`` task does nothing. 61``do_configure`` task does nothing.
62 62
@@ -73,13 +73,13 @@ Configures the runtime test suite included in the software being built.
73------------- 73-------------
74 74
75Writes output files that are to be deployed to 75Writes output files that are to be deployed to
76``${``\ ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__\ ``}``. The 76``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The
77task runs with the current working directory set to 77task runs with the current working directory set to
78``${``\ ```B`` <#var-B>`__\ ``}``. 78``${``\ :term:`B`\ ``}``.
79 79
80Recipes implementing this task should inherit the 80Recipes implementing this task should inherit the
81```deploy`` <#ref-classes-deploy>`__ class and should write the output 81:ref:`deploy <ref-classes-deploy>` class and should write the output
82to ``${``\ ```DEPLOYDIR`` <#var-DEPLOYDIR>`__\ ``}``, which is not to be 82to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be
83confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up 83confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up
84``do_deploy`` as a shared state (sstate) task that can be accelerated 84``do_deploy`` as a shared state (sstate) task that can be accelerated
85through sstate use. The sstate mechanism takes care of copying the 85through sstate use. The sstate mechanism takes care of copying the
@@ -93,7 +93,7 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
93 93
94The ``do_deploy`` task is not added as a task by default and 94The ``do_deploy`` task is not added as a task by default and
95consequently needs to be added manually. If you want the task to run 95consequently needs to be added manually. If you want the task to run
96after ```do_compile`` <#ref-tasks-compile>`__, you can add it by doing 96after :ref:`ref-tasks-compile`, you can add it by doing
97the following: addtask deploy after do_compile Adding ``do_deploy`` 97the following: addtask deploy after do_compile Adding ``do_deploy``
98after other tasks works the same way. 98after other tasks works the same way.
99 99
@@ -124,7 +124,7 @@ If the ``do_deploy`` task re-executes, any previous output is removed
124------------ 124------------
125 125
126Fetches the source code. This task uses the 126Fetches the source code. This task uses the
127```SRC_URI`` <#var-SRC_URI>`__ variable and the argument's prefix to 127:term:`SRC_URI` variable and the argument's prefix to
128determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__ 128determine the correct `fetcher <&YOCTO_DOCS_BB_URL;#bb-fetchers>`__
129module. 129module.
130 130
@@ -135,12 +135,12 @@ module.
135 135
136Starts the image generation process. The ``do_image`` task runs after 136Starts the image generation process. The ``do_image`` task runs after
137the OpenEmbedded build system has run the 137the OpenEmbedded build system has run the
138```do_rootfs`` <#ref-tasks-rootfs>`__ task during which packages are 138:ref:`ref-tasks-rootfs` task during which packages are
139identified for installation into the image and the root filesystem is 139identified for installation into the image and the root filesystem is
140created, complete with post-processing. 140created, complete with post-processing.
141 141
142The ``do_image`` task performs pre-processing on the image through the 142The ``do_image`` task performs pre-processing on the image through the
143```IMAGE_PREPROCESS_COMMAND`` <#var-IMAGE_PREPROCESS_COMMAND>`__ and 143:term:`IMAGE_PREPROCESS_COMMAND` and
144dynamically generates supporting ``do_image_*`` tasks as needed. 144dynamically generates supporting ``do_image_*`` tasks as needed.
145 145
146For more information on image creation, see the "`Image 146For more information on image creation, see the "`Image
@@ -154,13 +154,13 @@ section in the Yocto Project Overview and Concepts Manual.
154 154
155Completes the image generation process. The ``do_image_complete`` task 155Completes the image generation process. The ``do_image_complete`` task
156runs after the OpenEmbedded build system has run the 156runs after the OpenEmbedded build system has run the
157```do_image`` <#ref-tasks-image>`__ task during which image 157:ref:`ref-tasks-image` task during which image
158pre-processing occurs and through dynamically generated ``do_image_*`` 158pre-processing occurs and through dynamically generated ``do_image_*``
159tasks the image is constructed. 159tasks the image is constructed.
160 160
161The ``do_image_complete`` task performs post-processing on the image 161The ``do_image_complete`` task performs post-processing on the image
162through the 162through the
163```IMAGE_POSTPROCESS_COMMAND`` <#var-IMAGE_POSTPROCESS_COMMAND>`__. 163:term:`IMAGE_POSTPROCESS_COMMAND`.
164 164
165For more information on image creation, see the "`Image 165For more information on image creation, see the "`Image
166Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" 166Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__"
@@ -172,13 +172,13 @@ section in the Yocto Project Overview and Concepts Manual.
172-------------- 172--------------
173 173
174Copies files that are to be packaged into the holding area 174Copies files that are to be packaged into the holding area
175``${``\ ```D`` <#var-D>`__\ ``}``. This task runs with the current 175``${``\ :term:`D`\ ``}``. This task runs with the current
176working directory set to ``${``\ ```B`` <#var-B>`__\ ``}``, which is the 176working directory set to ``${``\ :term:`B`\ ``}``, which is the
177compilation directory. The ``do_install`` task, as well as other tasks 177compilation directory. The ``do_install`` task, as well as other tasks
178that either directly or indirectly depend on the installed files (e.g. 178that either directly or indirectly depend on the installed files (e.g.
179```do_package`` <#ref-tasks-package>`__, 179:ref:`ref-tasks-package`,
180```do_package_write_*`` <#ref-tasks-package_write_deb>`__, and 180```do_package_write_*`` <#ref-tasks-package_write_deb>`__, and
181```do_rootfs`` <#ref-tasks-rootfs>`__), run under 181:ref:`ref-tasks-rootfs`), run under
182`fakeroot <&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo>`__. 182`fakeroot <&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo>`__.
183 183
184.. note:: 184.. note::
@@ -199,7 +199,7 @@ that either directly or indirectly depend on the installed files (e.g.
199 199
200 - The ``tar`` command with the "--no-same-owner" option. See the 200 - The ``tar`` command with the "--no-same-owner" option. See the
201 ``bin_package.bbclass`` file in the ``meta/classes`` directory of 201 ``bin_package.bbclass`` file in the ``meta/classes`` directory of
202 the `Source Directory <#source-directory>`__ for an example. 202 the :term:`Source Directory` for an example.
203 203
204.. _ref-tasks-install_ptest_base: 204.. _ref-tasks-install_ptest_base:
205 205
@@ -215,15 +215,15 @@ holding area.
215-------------- 215--------------
216 216
217Analyzes the content of the holding area 217Analyzes the content of the holding area
218``${``\ ```D`` <#var-D>`__\ ``}`` and splits the content into subsets 218``${``\ :term:`D`\ ``}`` and splits the content into subsets
219based on available packages and files. This task makes use of the 219based on available packages and files. This task makes use of the
220```PACKAGES`` <#var-PACKAGES>`__ and ```FILES`` <#var-FILES>`__ 220:term:`PACKAGES` and :term:`FILES`
221variables. 221variables.
222 222
223The ``do_package`` task, in conjunction with the 223The ``do_package`` task, in conjunction with the
224```do_packagedata`` <#ref-tasks-packagedata>`__ task, also saves some 224:ref:`ref-tasks-packagedata` task, also saves some
225important package metadata. For additional information, see the 225important package metadata. For additional information, see the
226```PKGDESTWORK`` <#var-PKGDESTWORK>`__ variable and the "`Automatically 226:term:`PKGDESTWORK` variable and the "`Automatically
227Added Runtime 227Added Runtime
228Dependencies <&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies>`__" 228Dependencies <&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies>`__"
229section in the Yocto Project Overview and Concepts Manual. 229section in the Yocto Project Overview and Concepts Manual.
@@ -234,7 +234,7 @@ section in the Yocto Project Overview and Concepts Manual.
234----------------- 234-----------------
235 235
236Runs QA checks on packaged files. For more information on these checks, 236Runs QA checks on packaged files. For more information on these checks,
237see the ```insane`` <#ref-classes-insane>`__ class. 237see the :ref:`insane <ref-classes-insane>` class.
238 238
239.. _ref-tasks-package_write_deb: 239.. _ref-tasks-package_write_deb:
240 240
@@ -242,7 +242,7 @@ see the ```insane`` <#ref-classes-insane>`__ class.
242------------------------ 242------------------------
243 243
244Creates Debian packages (i.e. ``*.deb`` files) and places them in the 244Creates Debian packages (i.e. ``*.deb`` files) and places them in the
245``${``\ ```DEPLOY_DIR_DEB`` <#var-DEPLOY_DIR_DEB>`__\ ``}`` directory in 245``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in
246the package feeds area. For more information, see the "`Package 246the package feeds area. For more information, see the "`Package
247Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in 247Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
248the Yocto Project Overview and Concepts Manual. 248the Yocto Project Overview and Concepts Manual.
@@ -253,7 +253,7 @@ the Yocto Project Overview and Concepts Manual.
253------------------------ 253------------------------
254 254
255Creates IPK packages (i.e. ``*.ipk`` files) and places them in the 255Creates IPK packages (i.e. ``*.ipk`` files) and places them in the
256``${``\ ```DEPLOY_DIR_IPK`` <#var-DEPLOY_DIR_IPK>`__\ ``}`` directory in 256``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in
257the package feeds area. For more information, see the "`Package 257the package feeds area. For more information, see the "`Package
258Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in 258Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
259the Yocto Project Overview and Concepts Manual. 259the Yocto Project Overview and Concepts Manual.
@@ -264,7 +264,7 @@ the Yocto Project Overview and Concepts Manual.
264------------------------ 264------------------------
265 265
266Creates RPM packages (i.e. ``*.rpm`` files) and places them in the 266Creates RPM packages (i.e. ``*.rpm`` files) and places them in the
267``${``\ ```DEPLOY_DIR_RPM`` <#var-DEPLOY_DIR_RPM>`__\ ``}`` directory in 267``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in
268the package feeds area. For more information, see the "`Package 268the package feeds area. For more information, see the "`Package
269Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in 269Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
270the Yocto Project Overview and Concepts Manual. 270the Yocto Project Overview and Concepts Manual.
@@ -275,7 +275,7 @@ the Yocto Project Overview and Concepts Manual.
275------------------------ 275------------------------
276 276
277Creates tarballs and places them in the 277Creates tarballs and places them in the
278``${``\ ```DEPLOY_DIR_TAR`` <#var-DEPLOY_DIR_TAR>`__\ ``}`` directory in 278``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in
279the package feeds area. For more information, see the "`Package 279the package feeds area. For more information, see the "`Package
280Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in 280Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in
281the Yocto Project Overview and Concepts Manual. 281the Yocto Project Overview and Concepts Manual.
@@ -286,8 +286,8 @@ the Yocto Project Overview and Concepts Manual.
286------------------ 286------------------
287 287
288Saves package metadata generated by the 288Saves package metadata generated by the
289```do_package`` <#ref-tasks-package>`__ task in 289:ref:`ref-tasks-package` task in
290```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ to make it available globally. 290:term:`PKGDATA_DIR` to make it available globally.
291 291
292.. _ref-tasks-patch: 292.. _ref-tasks-patch:
293 293
@@ -297,7 +297,7 @@ Saves package metadata generated by the
297Locates patch files and applies them to the source code. 297Locates patch files and applies them to the source code.
298 298
299After fetching and unpacking source files, the build system uses the 299After fetching and unpacking source files, the build system uses the
300recipe's ```SRC_URI`` <&YOCTO_DOCS_REF_URL;#var-SRC_URI>`__ statements 300recipe's :term:`SRC_URI` statements
301to locate and apply patch files to the source code. 301to locate and apply patch files to the source code.
302 302
303.. note:: 303.. note::
@@ -375,7 +375,7 @@ information.
375----------------------- 375-----------------------
376 376
377Stages (copies) a subset of the files installed by the 377Stages (copies) a subset of the files installed by the
378```do_install`` <#ref-tasks-install>`__ task into the appropriate 378:ref:`ref-tasks-install` task into the appropriate
379sysroot. For information on how to access these files from other 379sysroot. For information on how to access these files from other
380recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables. 380recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables.
381Directories that would typically not be needed by other recipes at build 381Directories that would typically not be needed by other recipes at build
@@ -398,9 +398,9 @@ that if the task is re-executed, any previous output is removed (i.e.
398 398
399Installs the files into the individual recipe specific sysroots (i.e. 399Installs the files into the individual recipe specific sysroots (i.e.
400``recipe-sysroot`` and ``recipe-sysroot-native`` under 400``recipe-sysroot`` and ``recipe-sysroot-native`` under
401``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}`` based upon the 401``${``\ :term:`WORKDIR`\ ``}`` based upon the
402dependencies specified by ```DEPENDS`` <#var-DEPENDS>`__). See the 402dependencies specified by :term:`DEPENDS`). See the
403"```staging`` <#ref-classes-staging>`__" class for more information. 403":ref:`staging <ref-classes-staging>`" class for more information.
404 404
405.. _ref-tasks-rm_work: 405.. _ref-tasks-rm_work:
406 406
@@ -417,7 +417,7 @@ them. You can learn more by looking at the
417------------- 417-------------
418 418
419Unpacks the source code into a working directory pointed to by 419Unpacks the source code into a working directory pointed to by
420``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}``. The ```S`` <#var-S>`__ 420``${``\ :term:`WORKDIR`\ ``}``. The :term:`S`
421variable also plays a role in where unpacked source files ultimately 421variable also plays a role in where unpacked source files ultimately
422reside. For more information on how source files are unpacked, see the 422reside. For more information on how source files are unpacked, see the
423"`Source 423"`Source
@@ -459,7 +459,7 @@ default, the results are stored in ```$LOG_DIR`` <#var-LOG_DIR>`__ (e.g.
459``do_checkuri`` 459``do_checkuri``
460--------------- 460---------------
461 461
462Validates the ```SRC_URI`` <#var-SRC_URI>`__ value. 462Validates the :term:`SRC_URI` value.
463 463
464.. _ref-tasks-clean: 464.. _ref-tasks-clean:
465 465
@@ -467,11 +467,11 @@ Validates the ```SRC_URI`` <#var-SRC_URI>`__ value.
467------------ 467------------
468 468
469Removes all output files for a target from the 469Removes all output files for a target from the
470```do_unpack`` <#ref-tasks-unpack>`__ task forward (i.e. ``do_unpack``, 470:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``,
471```do_configure`` <#ref-tasks-configure>`__, 471:ref:`ref-tasks-configure`,
472```do_compile`` <#ref-tasks-compile>`__, 472:ref:`ref-tasks-compile`,
473```do_install`` <#ref-tasks-install>`__, and 473:ref:`ref-tasks-install`, and
474```do_package`` <#ref-tasks-package>`__). 474:ref:`ref-tasks-package`).
475 475
476You can run this task using BitBake as follows: $ bitbake -c clean 476You can run this task using BitBake as follows: $ bitbake -c clean
477recipe 477recipe
@@ -481,7 +481,7 @@ Running this task does not remove the
481Consequently, if no changes have been made and the recipe is rebuilt 481Consequently, if no changes have been made and the recipe is rebuilt
482after cleaning, output files are simply restored from the sstate cache. 482after cleaning, output files are simply restored from the sstate cache.
483If you want to remove the sstate cache files for the recipe, you need to 483If you want to remove the sstate cache files for the recipe, you need to
484use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead 484use the :ref:`ref-tasks-cleansstate` task instead
485(i.e. ``bitbake -c cleansstate`` recipe). 485(i.e. ``bitbake -c cleansstate`` recipe).
486 486
487.. _ref-tasks-cleanall: 487.. _ref-tasks-cleanall:
@@ -492,15 +492,15 @@ use the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task instead
492Removes all output files, shared state 492Removes all output files, shared state
493(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, and 493(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, and
494downloaded source files for a target (i.e. the contents of 494downloaded source files for a target (i.e. the contents of
495```DL_DIR`` <#var-DL_DIR>`__). Essentially, the ``do_cleanall`` task is 495:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is
496identical to the ```do_cleansstate`` <#ref-tasks-cleansstate>`__ task 496identical to the :ref:`ref-tasks-cleansstate` task
497with the added removal of downloaded source files. 497with the added removal of downloaded source files.
498 498
499You can run this task using BitBake as follows: $ bitbake -c cleanall 499You can run this task using BitBake as follows: $ bitbake -c cleanall
500recipe 500recipe
501 501
502Typically, you would not normally use the ``cleanall`` task. Do so only 502Typically, you would not normally use the ``cleanall`` task. Do so only
503if you want to start fresh with the ```do_fetch`` <#ref-tasks-fetch>`__ 503if you want to start fresh with the :ref:`ref-tasks-fetch`
504task. 504task.
505 505
506.. _ref-tasks-cleansstate: 506.. _ref-tasks-cleansstate:
@@ -511,7 +511,7 @@ task.
511Removes all output files and shared state 511Removes all output files and shared state
512(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache for a 512(`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache for a
513target. Essentially, the ``do_cleansstate`` task is identical to the 513target. Essentially, the ``do_cleansstate`` task is identical to the
514```do_clean`` <#ref-tasks-clean>`__ task with the added removal of 514:ref:`ref-tasks-clean` task with the added removal of
515shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) 515shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__)
516cache. 516cache.
517 517
@@ -596,7 +596,7 @@ The following tasks are applicable to image recipes.
596-------------- 596--------------
597 597
598Creates a bootable live image. See the 598Creates a bootable live image. See the
599```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable for additional 599:term:`IMAGE_FSTYPES` variable for additional
600information on live image types. 600information on live image types.
601 601
602.. _ref-tasks-bundle_initramfs: 602.. _ref-tasks-bundle_initramfs:
@@ -606,7 +606,7 @@ information on live image types.
606 606
607Combines an initial RAM disk (initramfs) image and kernel together to 607Combines an initial RAM disk (initramfs) image and kernel together to
608form a single image. The 608form a single image. The
609```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ variable 609:term:`CONFIG_INITRAMFS_SOURCE` variable
610has some more information about these types of images. 610has some more information about these types of images.
611 611
612.. _ref-tasks-rootfs: 612.. _ref-tasks-rootfs:
@@ -638,7 +638,7 @@ section in the Yocto Project Development Tasks Manual.
638 638
639Boots an image and performs runtime tests within the image immediately 639Boots an image and performs runtime tests within the image immediately
640after it has been built. This task is enabled when you set 640after it has been built. This task is enabled when you set
641```TESTIMAGE_AUTO`` <#var-TESTIMAGE_AUTO>`__ equal to "1". 641:term:`TESTIMAGE_AUTO` equal to "1".
642 642
643For information on automatically testing images, see the "`Performing 643For information on automatically testing images, see the "`Performing
644Automated Runtime 644Automated Runtime
@@ -649,7 +649,7 @@ Kernel-Related Tasks
649==================== 649====================
650 650
651The following tasks are applicable to kernel recipes. Some of these 651The following tasks are applicable to kernel recipes. Some of these
652tasks (e.g. the ```do_menuconfig`` <#ref-tasks-menuconfig>`__ task) are 652tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are
653also applicable to recipes that use Linux kernel style configuration 653also applicable to recipes that use Linux kernel style configuration
654such as the BusyBox recipe. 654such as the BusyBox recipe.
655 655
@@ -669,9 +669,9 @@ kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and
669 669
670When invoked by the user, this task creates a file containing the 670When invoked by the user, this task creates a file containing the
671differences between the original config as produced by 671differences between the original config as produced by
672```do_kernel_configme`` <#ref-tasks-kernel_configme>`__ task and the 672:ref:`ref-tasks-kernel_configme` task and the
673changes made by the user with other methods (i.e. using 673changes made by the user with other methods (i.e. using
674(```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__). Once the 674(:ref:`ref-tasks-kernel_menuconfig`). Once the
675file of differences is created, it can be used to create a config 675file of differences is created, it can be used to create a config
676fragment that only contains the differences. You can invoke this task 676fragment that only contains the differences. You can invoke this task
677from the command line as follows: $ bitbake linux-yocto -c diffconfig 677from the command line as follows: $ bitbake linux-yocto -c diffconfig
@@ -696,7 +696,7 @@ kernel with the correct branches checked out.
696------------------------- 696-------------------------
697 697
698Validates the configuration produced by the 698Validates the configuration produced by the
699```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. The 699:ref:`ref-tasks-kernel_menuconfig` task. The
700``do_kernel_configcheck`` task produces warnings when a requested 700``do_kernel_configcheck`` task produces warnings when a requested
701configuration does not appear in the final ``.config`` file or when you 701configuration does not appear in the final ``.config`` file or when you
702override a policy configuration in a hardware configuration fragment. 702override a policy configuration in a hardware configuration fragment.
@@ -711,7 +711,7 @@ section in the Yocto Project Linux Kernel Development Manual.
711``do_kernel_configme`` 711``do_kernel_configme``
712---------------------- 712----------------------
713 713
714After the kernel is patched by the ```do_patch`` <#ref-tasks-patch>`__ 714After the kernel is patched by the :ref:`ref-tasks-patch`
715task, the ``do_kernel_configme`` task assembles and merges all the 715task, the ``do_kernel_configme`` task assembles and merges all the
716kernel config fragments into a merged configuration that can then be 716kernel config fragments into a merged configuration that can then be
717passed to the kernel configuration phase proper. This is also the time 717passed to the kernel configuration phase proper. This is also the time
@@ -746,12 +746,12 @@ information on this configuration tool.
746---------------------- 746----------------------
747 747
748Collects all the features required for a given kernel build, whether the 748Collects all the features required for a given kernel build, whether the
749features come from ```SRC_URI`` <#var-SRC_URI>`__ or from Git 749features come from :term:`SRC_URI` or from Git
750repositories. After collection, the ``do_kernel_metadata`` task 750repositories. After collection, the ``do_kernel_metadata`` task
751processes the features into a series of config fragments and patches, 751processes the features into a series of config fragments and patches,
752which can then be applied by subsequent tasks such as 752which can then be applied by subsequent tasks such as
753```do_patch`` <#ref-tasks-patch>`__ and 753:ref:`ref-tasks-patch` and
754```do_kernel_configme`` <#ref-tasks-kernel_configme>`__. 754:ref:`ref-tasks-kernel_configme`.
755 755
756.. _ref-tasks-menuconfig: 756.. _ref-tasks-menuconfig:
757 757
@@ -772,7 +772,7 @@ When invoked by the user, creates a defconfig file that can be used
772instead of the default defconfig. The saved defconfig contains the 772instead of the default defconfig. The saved defconfig contains the
773differences between the default defconfig and the changes made by the 773differences between the default defconfig and the changes made by the
774user using other methods (i.e. the 774user using other methods (i.e. the
775```do_kernel_menuconfig`` <#ref-tasks-kernel_menuconfig>`__ task. You 775:ref:`ref-tasks-kernel_menuconfig` task. You
776can invoke the task using the following command: $ bitbake linux-yocto 776can invoke the task using the following command: $ bitbake linux-yocto
777-c savedefconfig 777-c savedefconfig
778 778
@@ -785,7 +785,7 @@ After the kernel has been compiled but before the kernel modules have
785been compiled, this task copies files required for module builds and 785been compiled, this task copies files required for module builds and
786which are generated from the kernel build into the shared work 786which are generated from the kernel build into the shared work
787directory. With these copies successfully copied, the 787directory. With these copies successfully copied, the
788```do_compile_kernelmodules`` <#ref-tasks-compile_kernelmodules>`__ task 788:ref:`ref-tasks-compile_kernelmodules` task
789can successfully build the kernel modules in the next step of the build. 789can successfully build the kernel modules in the next step of the build.
790 790
791.. _ref-tasks-sizecheck: 791.. _ref-tasks-sizecheck:
@@ -795,7 +795,7 @@ can successfully build the kernel modules in the next step of the build.
795 795
796After the kernel has been built, this task checks the size of the 796After the kernel has been built, this task checks the size of the
797stripped kernel image against 797stripped kernel image against
798```KERNEL_IMAGE_MAXSIZE`` <#var-KERNEL_IMAGE_MAXSIZE>`__. If that 798:term:`KERNEL_IMAGE_MAXSIZE`. If that
799variable was set and the size of the stripped kernel exceeds that size, 799variable was set and the size of the stripped kernel exceeds that size,
800the kernel build produces a warning to that effect. 800the kernel build produces a warning to that effect.
801 801
@@ -816,9 +816,9 @@ sections from a size-sensitive configuration.
816 816
817After the kernel is unpacked but before it is patched, this task makes 817After the kernel is unpacked but before it is patched, this task makes
818sure that the machine and metadata branches as specified by the 818sure that the machine and metadata branches as specified by the
819```SRCREV`` <#var-SRCREV>`__ variables actually exist on the specified 819:term:`SRCREV` variables actually exist on the specified
820branches. If these branches do not exist and 820branches. If these branches do not exist and
821```AUTOREV`` <#var-AUTOREV>`__ is not being used, the 821:term:`AUTOREV` is not being used, the
822``do_validate_branches`` task fails during the build. 822``do_validate_branches`` task fails during the build.
823 823
824Miscellaneous Tasks 824Miscellaneous Tasks
@@ -833,4 +833,4 @@ The following sections describe miscellaneous tasks.
833 833
834A build stage that takes the source code and scans it on a remote 834A build stage that takes the source code and scans it on a remote
835FOSSOLOGY server in order to produce an SPDX document. This task applies 835FOSSOLOGY server in order to produce an SPDX document. This task applies
836only to the ```spdx`` <#ref-classes-spdx>`__ class. 836only to the :ref:`spdx <ref-classes-spdx>` class.