diff options
Diffstat (limited to 'documentation/ref-manual/ref-tasks.rst')
-rw-r--r-- | documentation/ref-manual/ref-tasks.rst | 192 |
1 files changed, 110 insertions, 82 deletions
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 5b0711586f..44463f2236 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst | |||
@@ -109,7 +109,7 @@ after other tasks works the same way. | |||
109 | :: | 109 | :: |
110 | 110 | ||
111 | do_build[recrdeptask] += "do_deploy" | 111 | do_build[recrdeptask] += "do_deploy" |
112 | 112 | ||
113 | 113 | ||
114 | See the " | 114 | See the " |
115 | Dependencies | 115 | Dependencies |
@@ -143,8 +143,7 @@ The ``do_image`` task performs pre-processing on the image through the | |||
143 | :term:`IMAGE_PREPROCESS_COMMAND` and | 143 | :term:`IMAGE_PREPROCESS_COMMAND` and |
144 | dynamically generates supporting ``do_image_*`` tasks as needed. | 144 | dynamically generates supporting ``do_image_*`` tasks as needed. |
145 | 145 | ||
146 | For more information on image creation, see the "`Image | 146 | For more information on image creation, see the ":ref:`image-generation-dev-environment`" |
147 | Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" | ||
148 | section in the Yocto Project Overview and Concepts Manual. | 147 | section in the Yocto Project Overview and Concepts Manual. |
149 | 148 | ||
150 | .. _ref-tasks-image-complete: | 149 | .. _ref-tasks-image-complete: |
@@ -162,8 +161,8 @@ The ``do_image_complete`` task performs post-processing on the image | |||
162 | through the | 161 | through the |
163 | :term:`IMAGE_POSTPROCESS_COMMAND`. | 162 | :term:`IMAGE_POSTPROCESS_COMMAND`. |
164 | 163 | ||
165 | For more information on image creation, see the "`Image | 164 | For more information on image creation, see the |
166 | Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" | 165 | ":ref:`image-generation-dev-environment`" |
167 | section in the Yocto Project Overview and Concepts Manual. | 166 | section in the Yocto Project Overview and Concepts Manual. |
168 | 167 | ||
169 | .. _ref-tasks-install: | 168 | .. _ref-tasks-install: |
@@ -176,10 +175,9 @@ Copies files that are to be packaged into the holding area | |||
176 | working directory set to ``${``\ :term:`B`\ ``}``, which is the | 175 | working directory set to ``${``\ :term:`B`\ ``}``, which is the |
177 | compilation directory. The ``do_install`` task, as well as other tasks | 176 | compilation directory. The ``do_install`` task, as well as other tasks |
178 | that either directly or indirectly depend on the installed files (e.g. | 177 | that either directly or indirectly depend on the installed files (e.g. |
179 | :ref:`ref-tasks-package`, | 178 | :ref:`ref-tasks-package`, ``do_package_write_*``, and |
180 | ```do_package_write_*`` <#ref-tasks-package_write_deb>`__, and | ||
181 | :ref:`ref-tasks-rootfs`), run under | 179 | :ref:`ref-tasks-rootfs`), run under |
182 | `fakeroot <&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo>`__. | 180 | :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. |
183 | 181 | ||
184 | .. note:: | 182 | .. note:: |
185 | 183 | ||
@@ -187,9 +185,8 @@ that either directly or indirectly depend on the installed files (e.g. | |||
187 | of the installed files to unintended values. Some methods of copying | 185 | of the installed files to unintended values. Some methods of copying |
188 | files, notably when using the recursive ``cp`` command, can preserve | 186 | files, notably when using the recursive ``cp`` command, can preserve |
189 | the UID and/or GID of the original file, which is usually not what | 187 | the UID and/or GID of the original file, which is usually not what |
190 | you want. The | 188 | you want. The ``host-user-contaminated`` QA check checks for files |
191 | ```host-user-contaminated`` <#insane-host-user-contaminated>`__ QA | 189 | that probably have the wrong ownership. |
192 | check checks for files that probably have the wrong ownership. | ||
193 | 190 | ||
194 | Safe methods for installing files include the following: | 191 | Safe methods for installing files include the following: |
195 | 192 | ||
@@ -223,9 +220,8 @@ variables. | |||
223 | The ``do_package`` task, in conjunction with the | 220 | The ``do_package`` task, in conjunction with the |
224 | :ref:`ref-tasks-packagedata` task, also saves some | 221 | :ref:`ref-tasks-packagedata` task, also saves some |
225 | important package metadata. For additional information, see the | 222 | important package metadata. For additional information, see the |
226 | :term:`PKGDESTWORK` variable and the "`Automatically | 223 | :term:`PKGDESTWORK` variable and the |
227 | Added Runtime | 224 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" |
228 | Dependencies <&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies>`__" | ||
229 | section in the Yocto Project Overview and Concepts Manual. | 225 | section in the Yocto Project Overview and Concepts Manual. |
230 | 226 | ||
231 | .. _ref-tasks-package_qa: | 227 | .. _ref-tasks-package_qa: |
@@ -243,8 +239,8 @@ see the :ref:`insane <ref-classes-insane>` class. | |||
243 | 239 | ||
244 | Creates Debian packages (i.e. ``*.deb`` files) and places them in the | 240 | Creates Debian packages (i.e. ``*.deb`` files) and places them in the |
245 | ``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in | 241 | ``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in |
246 | the package feeds area. For more information, see the "`Package | 242 | the package feeds area. For more information, see the |
247 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in | 243 | ":ref:`package-feeds-dev-environment`" section in |
248 | the Yocto Project Overview and Concepts Manual. | 244 | the Yocto Project Overview and Concepts Manual. |
249 | 245 | ||
250 | .. _ref-tasks-package_write_ipk: | 246 | .. _ref-tasks-package_write_ipk: |
@@ -254,8 +250,8 @@ the Yocto Project Overview and Concepts Manual. | |||
254 | 250 | ||
255 | Creates IPK packages (i.e. ``*.ipk`` files) and places them in the | 251 | Creates IPK packages (i.e. ``*.ipk`` files) and places them in the |
256 | ``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in | 252 | ``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in |
257 | the package feeds area. For more information, see the "`Package | 253 | the package feeds area. For more information, see the |
258 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in | 254 | ":ref:`package-feeds-dev-environment`" section in |
259 | the Yocto Project Overview and Concepts Manual. | 255 | the Yocto Project Overview and Concepts Manual. |
260 | 256 | ||
261 | .. _ref-tasks-package_write_rpm: | 257 | .. _ref-tasks-package_write_rpm: |
@@ -265,8 +261,8 @@ the Yocto Project Overview and Concepts Manual. | |||
265 | 261 | ||
266 | Creates RPM packages (i.e. ``*.rpm`` files) and places them in the | 262 | Creates RPM packages (i.e. ``*.rpm`` files) and places them in the |
267 | ``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in | 263 | ``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in |
268 | the package feeds area. For more information, see the "`Package | 264 | the package feeds area. For more information, see the |
269 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in | 265 | ":ref:`package-feeds-dev-environment`" section in |
270 | the Yocto Project Overview and Concepts Manual. | 266 | the Yocto Project Overview and Concepts Manual. |
271 | 267 | ||
272 | .. _ref-tasks-package_write_tar: | 268 | .. _ref-tasks-package_write_tar: |
@@ -276,8 +272,8 @@ the Yocto Project Overview and Concepts Manual. | |||
276 | 272 | ||
277 | Creates tarballs and places them in the | 273 | Creates tarballs and places them in the |
278 | ``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in | 274 | ``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in |
279 | the package feeds area. For more information, see the "`Package | 275 | the package feeds area. For more information, see the |
280 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section in | 276 | ":ref:`package-feeds-dev-environment`" section in |
281 | the Yocto Project Overview and Concepts Manual. | 277 | the Yocto Project Overview and Concepts Manual. |
282 | 278 | ||
283 | .. _ref-tasks-packagedata: | 279 | .. _ref-tasks-packagedata: |
@@ -312,8 +308,14 @@ and kept in a subdirectory of the directory holding the recipe file. For | |||
312 | example, consider the | 308 | example, consider the |
313 | :yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>` | 309 | :yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>` |
314 | recipe from the OE-Core layer (i.e. ``poky/meta``): | 310 | recipe from the OE-Core layer (i.e. ``poky/meta``): |
315 | poky/meta/recipes-connectivity/bluez5 This recipe has two patch files | 311 | :: |
316 | located here: poky/meta/recipes-connectivity/bluez5/bluez5 | 312 | |
313 | poky/meta/recipes-connectivity/bluez5 | ||
314 | |||
315 | This recipe has two patch files located here: | ||
316 | :: | ||
317 | |||
318 | poky/meta/recipes-connectivity/bluez5/bluez5 | ||
317 | 319 | ||
318 | In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source | 320 | In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source |
319 | and patch files needed to build the package. | 321 | and patch files needed to build the package. |
@@ -331,23 +333,35 @@ and patch files needed to build the package. | |||
331 | As mentioned earlier, the build system treats files whose file types are | 333 | As mentioned earlier, the build system treats files whose file types are |
332 | ``.patch`` and ``.diff`` as patch files. However, you can use the | 334 | ``.patch`` and ``.diff`` as patch files. However, you can use the |
333 | "apply=yes" parameter with the ``SRC_URI`` statement to indicate any | 335 | "apply=yes" parameter with the ``SRC_URI`` statement to indicate any |
334 | file as a patch file: SRC_URI = " \\ git://path_to_repo/some_package \\ | 336 | file as a patch file: |
335 | file://file;apply=yes \\ " | 337 | :: |
338 | |||
339 | SRC_URI = " \\ | ||
340 | git://path_to_repo/some_package \\ | ||
341 | file://file;apply=yes \\ | ||
342 | " | ||
336 | 343 | ||
337 | Conversely, if you have a directory full of patch files and you want to | 344 | Conversely, if you have a directory full of patch files and you want to |
338 | exclude some so that the ``do_patch`` task does not apply them during | 345 | exclude some so that the ``do_patch`` task does not apply them during |
339 | the patch phase, you can use the "apply=no" parameter with the | 346 | the patch phase, you can use the "apply=no" parameter with the |
340 | ``SRC_URI`` statement: SRC_URI = " \\ git://path_to_repo/some_package \\ | 347 | ``SRC_URI`` statement: |
341 | file://path_to_lots_of_patch_files \\ | 348 | :: |
342 | file://path_to_lots_of_patch_files/patch_file5;apply=no \\ " In the | 349 | |
350 | SRC_URI = " \ | ||
351 | git://path_to_repo/some_package \ | ||
352 | file://path_to_lots_of_patch_files \ | ||
353 | file://path_to_lots_of_patch_files/patch_file5;apply=no \ | ||
354 | " | ||
355 | |||
356 | In the | ||
343 | previous example, assuming all the files in the directory holding the | 357 | previous example, assuming all the files in the directory holding the |
344 | patch files end with either ``.patch`` or ``.diff``, every file would be | 358 | patch files end with either ``.patch`` or ``.diff``, every file would be |
345 | applied as a patch by default except for the patch_file5 patch. | 359 | applied as a patch by default except for the patch_file5 patch. |
346 | 360 | ||
347 | You can find out more about the patching process in the | 361 | You can find out more about the patching process in the |
348 | "`Patching <&YOCTO_DOCS_OM_URL;#patching-dev-environment>`__" section in | 362 | ":ref:`patching-dev-environment`" section in |
349 | the Yocto Project Overview and Concepts Manual and the "`Patching | 363 | the Yocto Project Overview and Concepts Manual and the |
350 | Code <&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code>`__" section in the | 364 | ":ref:`new-recipe-patching-code`" section in the |
351 | Yocto Project Development Tasks Manual. | 365 | Yocto Project Development Tasks Manual. |
352 | 366 | ||
353 | .. _ref-tasks-populate_lic: | 367 | .. _ref-tasks-populate_lic: |
@@ -364,8 +378,7 @@ the image is constructed. | |||
364 | ------------------- | 378 | ------------------- |
365 | 379 | ||
366 | Creates the file and directory structure for an installable SDK. See the | 380 | Creates the file and directory structure for an installable SDK. See the |
367 | "`SDK | 381 | ":ref:`sdk-generation-dev-environment`" |
368 | Generation <&YOCTO_DOCS_OM_URL;#sdk-generation-dev-environment>`__" | ||
369 | section in the Yocto Project Overview and Concepts Manual for more | 382 | section in the Yocto Project Overview and Concepts Manual for more |
370 | information. | 383 | information. |
371 | 384 | ||
@@ -420,8 +433,7 @@ Unpacks the source code into a working directory pointed to by | |||
420 | ``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` | 433 | ``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` |
421 | variable also plays a role in where unpacked source files ultimately | 434 | variable also plays a role in where unpacked source files ultimately |
422 | reside. For more information on how source files are unpacked, see the | 435 | reside. For more information on how source files are unpacked, see the |
423 | "`Source | 436 | ":ref:`source-fetching-dev-environment`" |
424 | Fetching <&YOCTO_DOCS_OM_URL;#source-fetching-dev-environment>`__" | ||
425 | section in the Yocto Project Overview and Concepts Manual and also see | 437 | section in the Yocto Project Overview and Concepts Manual and also see |
426 | the ``WORKDIR`` and ``S`` variable descriptions. | 438 | the ``WORKDIR`` and ``S`` variable descriptions. |
427 | 439 | ||
@@ -442,16 +454,24 @@ of the recipe exists upstream and a status of not updated, updated, or | |||
442 | unknown. | 454 | unknown. |
443 | 455 | ||
444 | To check the upstream version and status of a recipe, use the following | 456 | To check the upstream version and status of a recipe, use the following |
445 | devtool commands: $ devtool latest-version $ devtool | 457 | devtool commands: |
446 | check-upgrade-status See the "```devtool`` Quick | 458 | :: |
447 | Reference <#ref-devtool-reference>`__" chapter for more information on | 459 | |
448 | ``devtool``. See the "`Checking on the Upgrade Status of a | 460 | $ devtool latest-version |
449 | Recipe <&YOCTO_DOCS_REF_URL;#devtool-checking-on-the-upgrade-status-of-a-recipe>`__" | 461 | $ devtool check-upgrade-status |
462 | |||
463 | See the ":ref:`ref-manual/ref-devtool-reference:\`\`devtool\`\` quick reference`" | ||
464 | chapter for more information on | ||
465 | ``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" | ||
450 | section for information on checking the upgrade status of a recipe. | 466 | section for information on checking the upgrade status of a recipe. |
451 | 467 | ||
452 | To build the ``checkpkg`` task, use the ``bitbake`` command with the | 468 | To build the ``checkpkg`` task, use the ``bitbake`` command with the |
453 | "-c" option and task name: $ bitbake core-image-minimal -c checkpkg By | 469 | "-c" option and task name: |
454 | default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g. | 470 | :: |
471 | |||
472 | $ bitbake core-image-minimal -c checkpkg | ||
473 | |||
474 | By default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g. | ||
455 | ``$BUILD_DIR/tmp/log``). | 475 | ``$BUILD_DIR/tmp/log``). |
456 | 476 | ||
457 | .. _ref-tasks-checkuri: | 477 | .. _ref-tasks-checkuri: |
@@ -473,11 +493,13 @@ Removes all output files for a target from the | |||
473 | :ref:`ref-tasks-install`, and | 493 | :ref:`ref-tasks-install`, and |
474 | :ref:`ref-tasks-package`). | 494 | :ref:`ref-tasks-package`). |
475 | 495 | ||
476 | You can run this task using BitBake as follows: $ bitbake -c clean | 496 | You can run this task using BitBake as follows: |
477 | recipe | 497 | :: |
498 | |||
499 | $ bitbake -c clean recipe | ||
478 | 500 | ||
479 | Running this task does not remove the | 501 | Running this task does not remove the |
480 | `sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__ cache files. | 502 | :ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>` cache files. |
481 | Consequently, if no changes have been made and the recipe is rebuilt | 503 | Consequently, if no changes have been made and the recipe is rebuilt |
482 | after cleaning, output files are simply restored from the sstate cache. | 504 | after cleaning, output files are simply restored from the sstate cache. |
483 | If you want to remove the sstate cache files for the recipe, you need to | 505 | If you want to remove the sstate cache files for the recipe, you need to |
@@ -490,14 +512,16 @@ use the :ref:`ref-tasks-cleansstate` task instead | |||
490 | --------------- | 512 | --------------- |
491 | 513 | ||
492 | Removes all output files, shared state | 514 | Removes all output files, shared state |
493 | (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache, and | 515 | (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, and |
494 | downloaded source files for a target (i.e. the contents of | 516 | downloaded source files for a target (i.e. the contents of |
495 | :term:`DL_DIR`). Essentially, the ``do_cleanall`` task is | 517 | :term:`DL_DIR`). Essentially, the ``do_cleanall`` task is |
496 | identical to the :ref:`ref-tasks-cleansstate` task | 518 | identical to the :ref:`ref-tasks-cleansstate` task |
497 | with the added removal of downloaded source files. | 519 | with the added removal of downloaded source files. |
498 | 520 | ||
499 | You can run this task using BitBake as follows: $ bitbake -c cleanall | 521 | You can run this task using BitBake as follows: |
500 | recipe | 522 | :: |
523 | |||
524 | $ bitbake -c cleanall recipe | ||
501 | 525 | ||
502 | Typically, you would not normally use the ``cleanall`` task. Do so only | 526 | Typically, you would not normally use the ``cleanall`` task. Do so only |
503 | if you want to start fresh with the :ref:`ref-tasks-fetch` | 527 | if you want to start fresh with the :ref:`ref-tasks-fetch` |
@@ -509,14 +533,16 @@ task. | |||
509 | ------------------ | 533 | ------------------ |
510 | 534 | ||
511 | Removes all output files and shared state | 535 | Removes all output files and shared state |
512 | (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) cache for a | 536 | (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a |
513 | target. Essentially, the ``do_cleansstate`` task is identical to the | 537 | target. Essentially, the ``do_cleansstate`` task is identical to the |
514 | :ref:`ref-tasks-clean` task with the added removal of | 538 | :ref:`ref-tasks-clean` task with the added removal of |
515 | shared state (`sstate <&YOCTO_DOCS_OM_URL;#shared-state-cache>`__) | 539 | shared state (`:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) |
516 | cache. | 540 | cache. |
517 | 541 | ||
518 | You can run this task using BitBake as follows: $ bitbake -c cleansstate | 542 | You can run this task using BitBake as follows: |
519 | recipe | 543 | :: |
544 | |||
545 | $ bitbake -c cleansstate recipe | ||
520 | 546 | ||
521 | When you run the ``do_cleansstate`` task, the OpenEmbedded build system | 547 | When you run the ``do_cleansstate`` task, the OpenEmbedded build system |
522 | no longer uses any sstate. Consequently, building the recipe from | 548 | no longer uses any sstate. Consequently, building the recipe from |
@@ -531,8 +557,8 @@ scratch is guaranteed. | |||
531 | as follows: | 557 | as follows: |
532 | :: | 558 | :: |
533 | 559 | ||
534 | $ bitbake -f -c do_cleansstate target | 560 | $ bitbake -f -c do_cleansstate target |
535 | 561 | ||
536 | 562 | ||
537 | .. _ref-tasks-devpyshell: | 563 | .. _ref-tasks-devpyshell: |
538 | 564 | ||
@@ -542,9 +568,7 @@ scratch is guaranteed. | |||
542 | Starts a shell in which an interactive Python interpreter allows you to | 568 | Starts a shell in which an interactive Python interpreter allows you to |
543 | interact with the BitBake build environment. From within this shell, you | 569 | interact with the BitBake build environment. From within this shell, you |
544 | can directly examine and set bits from the data store and execute | 570 | can directly examine and set bits from the data store and execute |
545 | functions as if within the BitBake environment. See the "`Using a | 571 | functions as if within the BitBake environment. See the ":ref:`platdev-appdev-devpyshell`" section in |
546 | Development Python | ||
547 | Shell <&YOCTO_DOCS_DEV_URL;#platdev-appdev-devpyshell>`__" section in | ||
548 | the Yocto Project Development Tasks Manual for more information about | 572 | the Yocto Project Development Tasks Manual for more information about |
549 | using ``devpyshell``. | 573 | using ``devpyshell``. |
550 | 574 | ||
@@ -554,8 +578,7 @@ using ``devpyshell``. | |||
554 | --------------- | 578 | --------------- |
555 | 579 | ||
556 | Starts a shell whose environment is set up for development, debugging, | 580 | Starts a shell whose environment is set up for development, debugging, |
557 | or both. See the "`Using a Development | 581 | or both. See the ":ref:`platdev-appdev-devshell`" section in the |
558 | Shell <&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell>`__" section in the | ||
559 | Yocto Project Development Tasks Manual for more information about using | 582 | Yocto Project Development Tasks Manual for more information about using |
560 | ``devshell``. | 583 | ``devshell``. |
561 | 584 | ||
@@ -571,8 +594,7 @@ Lists all defined tasks for a target. | |||
571 | ``do_package_index`` | 594 | ``do_package_index`` |
572 | -------------------- | 595 | -------------------- |
573 | 596 | ||
574 | Creates or updates the index in the `Package | 597 | Creates or updates the index in the `:ref:`package-feeds-dev-environment` area. |
575 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__ area. | ||
576 | 598 | ||
577 | .. note:: | 599 | .. note:: |
578 | 600 | ||
@@ -615,8 +637,7 @@ has some more information about these types of images. | |||
615 | ------------- | 637 | ------------- |
616 | 638 | ||
617 | Creates the root filesystem (file and directory structure) for an image. | 639 | Creates the root filesystem (file and directory structure) for an image. |
618 | See the "`Image | 640 | See the ":ref:`image-generation-dev-environment`" |
619 | Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" | ||
620 | section in the Yocto Project Overview and Concepts Manual for more | 641 | section in the Yocto Project Overview and Concepts Manual for more |
621 | information on how the root filesystem is created. | 642 | information on how the root filesystem is created. |
622 | 643 | ||
@@ -626,9 +647,8 @@ information on how the root filesystem is created. | |||
626 | ---------------- | 647 | ---------------- |
627 | 648 | ||
628 | Boots an image and performs runtime tests within the image. For | 649 | Boots an image and performs runtime tests within the image. For |
629 | information on automatically testing images, see the "`Performing | 650 | information on automatically testing images, see the |
630 | Automated Runtime | 651 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" |
631 | Testing <&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing>`__" | ||
632 | section in the Yocto Project Development Tasks Manual. | 652 | section in the Yocto Project Development Tasks Manual. |
633 | 653 | ||
634 | .. _ref-tasks-testimage_auto: | 654 | .. _ref-tasks-testimage_auto: |
@@ -640,9 +660,8 @@ Boots an image and performs runtime tests within the image immediately | |||
640 | after it has been built. This task is enabled when you set | 660 | after it has been built. This task is enabled when you set |
641 | :term:`TESTIMAGE_AUTO` equal to "1". | 661 | :term:`TESTIMAGE_AUTO` equal to "1". |
642 | 662 | ||
643 | For information on automatically testing images, see the "`Performing | 663 | For information on automatically testing images, see the |
644 | Automated Runtime | 664 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" |
645 | Testing <&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing>`__" | ||
646 | section in the Yocto Project Development Tasks Manual. | 665 | section in the Yocto Project Development Tasks Manual. |
647 | 666 | ||
648 | Kernel-Related Tasks | 667 | Kernel-Related Tasks |
@@ -674,9 +693,13 @@ changes made by the user with other methods (i.e. using | |||
674 | (:ref:`ref-tasks-kernel_menuconfig`). Once the | 693 | (:ref:`ref-tasks-kernel_menuconfig`). Once the |
675 | file of differences is created, it can be used to create a config | 694 | file of differences is created, it can be used to create a config |
676 | fragment that only contains the differences. You can invoke this task | 695 | fragment that only contains the differences. You can invoke this task |
677 | from the command line as follows: $ bitbake linux-yocto -c diffconfig | 696 | from the command line as follows: |
678 | For more information, see the "`Creating Configuration | 697 | :: |
679 | Fragments <&YOCTO_DOCS_KERNEL_DEV_URL;#creating-config-fragments>`__" | 698 | |
699 | $ bitbake linux-yocto -c diffconfig | ||
700 | |||
701 | For more information, see the | ||
702 | ":ref:`kernel-dev/kernel-dev-common:creating configuration fragments`" | ||
680 | section in the Yocto Project Linux Kernel Development Manual. | 703 | section in the Yocto Project Linux Kernel Development Manual. |
681 | 704 | ||
682 | .. _ref-tasks-kernel_checkout: | 705 | .. _ref-tasks-kernel_checkout: |
@@ -701,9 +724,13 @@ Validates the configuration produced by the | |||
701 | configuration does not appear in the final ``.config`` file or when you | 724 | configuration does not appear in the final ``.config`` file or when you |
702 | override a policy configuration in a hardware configuration fragment. | 725 | override a policy configuration in a hardware configuration fragment. |
703 | You can run this task explicitly and view the output by using the | 726 | You can run this task explicitly and view the output by using the |
704 | following command: $ bitbake linux-yocto -c kernel_configcheck -f For | 727 | following command: |
705 | more information, see the "`Validating | 728 | :: |
706 | Configuration <&YOCTO_DOCS_KERNEL_DEV_URL;#validating-configuration>`__" | 729 | |
730 | $ bitbake linux-yocto -c kernel_configcheck -f | ||
731 | |||
732 | For more information, see the | ||
733 | ":ref:`kernel-dev/kernel-dev-common:validating configuration`" | ||
707 | section in the Yocto Project Linux Kernel Development Manual. | 734 | section in the Yocto Project Linux Kernel Development Manual. |
708 | 735 | ||
709 | .. _ref-tasks-kernel_configme: | 736 | .. _ref-tasks-kernel_configme: |
@@ -733,10 +760,9 @@ tool, which you then use to modify the kernel configuration. | |||
733 | :: | 760 | :: |
734 | 761 | ||
735 | $ bitbake linux-yocto -c menuconfig | 762 | $ bitbake linux-yocto -c menuconfig |
736 | |||
737 | 763 | ||
738 | See the "`Using | 764 | |
739 | ``menuconfig`` <&YOCTO_DOCS_KERNEL_DEV_URL;#using-menuconfig>`__" | 765 | See the ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" |
740 | section in the Yocto Project Linux Kernel Development Manual for more | 766 | section in the Yocto Project Linux Kernel Development Manual for more |
741 | information on this configuration tool. | 767 | information on this configuration tool. |
742 | 768 | ||
@@ -760,7 +786,7 @@ which can then be applied by subsequent tasks such as | |||
760 | 786 | ||
761 | Runs ``make menuconfig`` for the kernel. For information on | 787 | Runs ``make menuconfig`` for the kernel. For information on |
762 | ``menuconfig``, see the | 788 | ``menuconfig``, see the |
763 | "`Using ``menuconfig`` <&YOCTO_DOCS_KERNEL_DEV_URL;#using-menuconfig>`__" | 789 | ":ref:`kernel-dev/kernel-dev-common:using \`\`menuconfig\`\``" |
764 | section in the Yocto Project Linux Kernel Development Manual. | 790 | section in the Yocto Project Linux Kernel Development Manual. |
765 | 791 | ||
766 | .. _ref-tasks-savedefconfig: | 792 | .. _ref-tasks-savedefconfig: |
@@ -773,8 +799,10 @@ instead of the default defconfig. The saved defconfig contains the | |||
773 | differences between the default defconfig and the changes made by the | 799 | differences between the default defconfig and the changes made by the |
774 | user using other methods (i.e. the | 800 | user using other methods (i.e. the |
775 | :ref:`ref-tasks-kernel_menuconfig` task. You | 801 | :ref:`ref-tasks-kernel_menuconfig` task. You |
776 | can invoke the task using the following command: $ bitbake linux-yocto | 802 | can invoke the task using the following command: |
777 | -c savedefconfig | 803 | :: |
804 | |||
805 | $ bitbake linux-yocto -c savedefconfig | ||
778 | 806 | ||
779 | .. _ref-tasks-shared_workdir: | 807 | .. _ref-tasks-shared_workdir: |
780 | 808 | ||