diff options
Diffstat (limited to 'documentation/ref-manual/tasks.rst')
-rw-r--r-- | documentation/ref-manual/tasks.rst | 48 |
1 files changed, 16 insertions, 32 deletions
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 9fe1c296aa..001edf6bb3 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -93,8 +93,7 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. | |||
93 | The ``do_deploy`` task is not added as a task by default and | 93 | The ``do_deploy`` task is not added as a task by default and |
94 | consequently needs to be added manually. If you want the task to run | 94 | consequently needs to be added manually. If you want the task to run |
95 | after :ref:`ref-tasks-compile`, you can add it by doing | 95 | after :ref:`ref-tasks-compile`, you can add it by doing |
96 | the following: | 96 | the following:: |
97 | :: | ||
98 | 97 | ||
99 | addtask deploy after do_compile | 98 | addtask deploy after do_compile |
100 | 99 | ||
@@ -103,8 +102,7 @@ Adding ``do_deploy`` after other tasks works the same way. | |||
103 | .. note:: | 102 | .. note:: |
104 | 103 | ||
105 | You do not need to add ``before do_build`` to the ``addtask`` command | 104 | You do not need to add ``before do_build`` to the ``addtask`` command |
106 | (though it is harmless), because the ``base`` class contains the following: | 105 | (though it is harmless), because the ``base`` class contains the following:: |
107 | :: | ||
108 | 106 | ||
109 | do_build[recrdeptask] += "do_deploy" | 107 | do_build[recrdeptask] += "do_deploy" |
110 | 108 | ||
@@ -302,13 +300,11 @@ Patch files, by default, are ``*.patch`` and ``*.diff`` files created | |||
302 | and kept in a subdirectory of the directory holding the recipe file. For | 300 | and kept in a subdirectory of the directory holding the recipe file. For |
303 | example, consider the | 301 | example, consider the |
304 | :yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>` | 302 | :yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>` |
305 | recipe from the OE-Core layer (i.e. ``poky/meta``): | 303 | recipe from the OE-Core layer (i.e. ``poky/meta``):: |
306 | :: | ||
307 | 304 | ||
308 | poky/meta/recipes-connectivity/bluez5 | 305 | poky/meta/recipes-connectivity/bluez5 |
309 | 306 | ||
310 | This recipe has two patch files located here: | 307 | This recipe has two patch files located here:: |
311 | :: | ||
312 | 308 | ||
313 | poky/meta/recipes-connectivity/bluez5/bluez5 | 309 | poky/meta/recipes-connectivity/bluez5/bluez5 |
314 | 310 | ||
@@ -323,8 +319,7 @@ and patch files needed to build the package. | |||
323 | As mentioned earlier, the build system treats files whose file types are | 319 | As mentioned earlier, the build system treats files whose file types are |
324 | ``.patch`` and ``.diff`` as patch files. However, you can use the | 320 | ``.patch`` and ``.diff`` as patch files. However, you can use the |
325 | "apply=yes" parameter with the ``SRC_URI`` statement to indicate any | 321 | "apply=yes" parameter with the ``SRC_URI`` statement to indicate any |
326 | file as a patch file: | 322 | file as a patch file:: |
327 | :: | ||
328 | 323 | ||
329 | SRC_URI = " \ | 324 | SRC_URI = " \ |
330 | git://path_to_repo/some_package \ | 325 | git://path_to_repo/some_package \ |
@@ -334,8 +329,7 @@ file as a patch file: | |||
334 | Conversely, if you have a directory full of patch files and you want to | 329 | Conversely, if you have a directory full of patch files and you want to |
335 | exclude some so that the ``do_patch`` task does not apply them during | 330 | exclude some so that the ``do_patch`` task does not apply them during |
336 | the patch phase, you can use the "apply=no" parameter with the | 331 | the patch phase, you can use the "apply=no" parameter with the |
337 | ``SRC_URI`` statement: | 332 | ``SRC_URI`` statement:: |
338 | :: | ||
339 | 333 | ||
340 | SRC_URI = " \ | 334 | SRC_URI = " \ |
341 | git://path_to_repo/some_package \ | 335 | git://path_to_repo/some_package \ |
@@ -455,8 +449,7 @@ of the recipe exists upstream and a status of not updated, updated, or | |||
455 | unknown. | 449 | unknown. |
456 | 450 | ||
457 | To check the upstream version and status of a recipe, use the following | 451 | To check the upstream version and status of a recipe, use the following |
458 | devtool commands: | 452 | devtool commands:: |
459 | :: | ||
460 | 453 | ||
461 | $ devtool latest-version | 454 | $ devtool latest-version |
462 | $ devtool check-upgrade-status | 455 | $ devtool check-upgrade-status |
@@ -467,8 +460,7 @@ chapter for more information on | |||
467 | section for information on checking the upgrade status of a recipe. | 460 | section for information on checking the upgrade status of a recipe. |
468 | 461 | ||
469 | To build the ``checkpkg`` task, use the ``bitbake`` command with the | 462 | To build the ``checkpkg`` task, use the ``bitbake`` command with the |
470 | "-c" option and task name: | 463 | "-c" option and task name:: |
471 | :: | ||
472 | 464 | ||
473 | $ bitbake core-image-minimal -c checkpkg | 465 | $ bitbake core-image-minimal -c checkpkg |
474 | 466 | ||
@@ -494,8 +486,7 @@ Removes all output files for a target from the | |||
494 | :ref:`ref-tasks-install`, and | 486 | :ref:`ref-tasks-install`, and |
495 | :ref:`ref-tasks-package`). | 487 | :ref:`ref-tasks-package`). |
496 | 488 | ||
497 | You can run this task using BitBake as follows: | 489 | You can run this task using BitBake as follows:: |
498 | :: | ||
499 | 490 | ||
500 | $ bitbake -c clean recipe | 491 | $ bitbake -c clean recipe |
501 | 492 | ||
@@ -519,8 +510,7 @@ downloaded source files for a target (i.e. the contents of | |||
519 | identical to the :ref:`ref-tasks-cleansstate` task | 510 | identical to the :ref:`ref-tasks-cleansstate` task |
520 | with the added removal of downloaded source files. | 511 | with the added removal of downloaded source files. |
521 | 512 | ||
522 | You can run this task using BitBake as follows: | 513 | You can run this task using BitBake as follows:: |
523 | :: | ||
524 | 514 | ||
525 | $ bitbake -c cleanall recipe | 515 | $ bitbake -c cleanall recipe |
526 | 516 | ||
@@ -540,8 +530,7 @@ target. Essentially, the ``do_cleansstate`` task is identical to the | |||
540 | shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`) | 530 | shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`) |
541 | cache. | 531 | cache. |
542 | 532 | ||
543 | You can run this task using BitBake as follows: | 533 | You can run this task using BitBake as follows:: |
544 | :: | ||
545 | 534 | ||
546 | $ bitbake -c cleansstate recipe | 535 | $ bitbake -c cleansstate recipe |
547 | 536 | ||
@@ -553,8 +542,7 @@ scratch is guaranteed. | |||
553 | 542 | ||
554 | The ``do_cleansstate`` task cannot remove sstate from a remote sstate | 543 | The ``do_cleansstate`` task cannot remove sstate from a remote sstate |
555 | mirror. If you need to build a target from scratch using remote mirrors, use | 544 | mirror. If you need to build a target from scratch using remote mirrors, use |
556 | the "-f" option as follows: | 545 | the "-f" option as follows:: |
557 | :: | ||
558 | 546 | ||
559 | $ bitbake -f -c do_cleansstate target | 547 | $ bitbake -f -c do_cleansstate target |
560 | 548 | ||
@@ -687,8 +675,7 @@ changes made by the user with other methods (i.e. using | |||
687 | (:ref:`ref-tasks-kernel_menuconfig`). Once the | 675 | (:ref:`ref-tasks-kernel_menuconfig`). Once the |
688 | file of differences is created, it can be used to create a config | 676 | file of differences is created, it can be used to create a config |
689 | fragment that only contains the differences. You can invoke this task | 677 | fragment that only contains the differences. You can invoke this task |
690 | from the command line as follows: | 678 | from the command line as follows:: |
691 | :: | ||
692 | 679 | ||
693 | $ bitbake linux-yocto -c diffconfig | 680 | $ bitbake linux-yocto -c diffconfig |
694 | 681 | ||
@@ -718,8 +705,7 @@ Validates the configuration produced by the | |||
718 | configuration does not appear in the final ``.config`` file or when you | 705 | configuration does not appear in the final ``.config`` file or when you |
719 | override a policy configuration in a hardware configuration fragment. | 706 | override a policy configuration in a hardware configuration fragment. |
720 | You can run this task explicitly and view the output by using the | 707 | You can run this task explicitly and view the output by using the |
721 | following command: | 708 | following command:: |
722 | :: | ||
723 | 709 | ||
724 | $ bitbake linux-yocto -c kernel_configcheck -f | 710 | $ bitbake linux-yocto -c kernel_configcheck -f |
725 | 711 | ||
@@ -750,8 +736,7 @@ tool, which you then use to modify the kernel configuration. | |||
750 | 736 | ||
751 | .. note:: | 737 | .. note:: |
752 | 738 | ||
753 | You can also invoke this tool from the command line as follows: | 739 | You can also invoke this tool from the command line as follows:: |
754 | :: | ||
755 | 740 | ||
756 | $ bitbake linux-yocto -c menuconfig | 741 | $ bitbake linux-yocto -c menuconfig |
757 | 742 | ||
@@ -793,8 +778,7 @@ instead of the default defconfig. The saved defconfig contains the | |||
793 | differences between the default defconfig and the changes made by the | 778 | differences between the default defconfig and the changes made by the |
794 | user using other methods (i.e. the | 779 | user using other methods (i.e. the |
795 | :ref:`ref-tasks-kernel_menuconfig` task. You | 780 | :ref:`ref-tasks-kernel_menuconfig` task. You |
796 | can invoke the task using the following command: | 781 | can invoke the task using the following command:: |
797 | :: | ||
798 | 782 | ||
799 | $ bitbake linux-yocto -c savedefconfig | 783 | $ bitbake linux-yocto -c savedefconfig |
800 | 784 | ||