diff options
Diffstat (limited to 'documentation/ref-manual/ref-tasks.rst')
| -rw-r--r-- | documentation/ref-manual/ref-tasks.rst | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 768c10eebd..8b9e0c2d89 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst | |||
| @@ -140,7 +140,7 @@ The ``do_image`` task performs pre-processing on the image through the | |||
| 140 | :term:`IMAGE_PREPROCESS_COMMAND` and | 140 | :term:`IMAGE_PREPROCESS_COMMAND` and |
| 141 | dynamically generates supporting ``do_image_*`` tasks as needed. | 141 | dynamically generates supporting ``do_image_*`` tasks as needed. |
| 142 | 142 | ||
| 143 | For more information on image creation, see the ":ref:`overview-manual/overview-manual-concepts:image generation`" | 143 | For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`" |
| 144 | section in the Yocto Project Overview and Concepts Manual. | 144 | section in the Yocto Project Overview and Concepts Manual. |
| 145 | 145 | ||
| 146 | .. _ref-tasks-image-complete: | 146 | .. _ref-tasks-image-complete: |
| @@ -159,7 +159,7 @@ through the | |||
| 159 | :term:`IMAGE_POSTPROCESS_COMMAND`. | 159 | :term:`IMAGE_POSTPROCESS_COMMAND`. |
| 160 | 160 | ||
| 161 | For more information on image creation, see the | 161 | For more information on image creation, see the |
| 162 | ":ref:`overview-manual/overview-manual-concepts:image generation`" | 162 | ":ref:`overview-manual/concepts:image generation`" |
| 163 | section in the Yocto Project Overview and Concepts Manual. | 163 | section in the Yocto Project Overview and Concepts Manual. |
| 164 | 164 | ||
| 165 | .. _ref-tasks-install: | 165 | .. _ref-tasks-install: |
| @@ -174,7 +174,7 @@ compilation directory. The ``do_install`` task, as well as other tasks | |||
| 174 | that either directly or indirectly depend on the installed files (e.g. | 174 | that either directly or indirectly depend on the installed files (e.g. |
| 175 | :ref:`ref-tasks-package`, ``do_package_write_*``, and | 175 | :ref:`ref-tasks-package`, ``do_package_write_*``, and |
| 176 | :ref:`ref-tasks-rootfs`), run under | 176 | :ref:`ref-tasks-rootfs`), run under |
| 177 | :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`. | 177 | :ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`. |
| 178 | 178 | ||
| 179 | .. note:: | 179 | .. note:: |
| 180 | 180 | ||
| @@ -218,7 +218,7 @@ The ``do_package`` task, in conjunction with the | |||
| 218 | :ref:`ref-tasks-packagedata` task, also saves some | 218 | :ref:`ref-tasks-packagedata` task, also saves some |
| 219 | important package metadata. For additional information, see the | 219 | important package metadata. For additional information, see the |
| 220 | :term:`PKGDESTWORK` variable and the | 220 | :term:`PKGDESTWORK` variable and the |
| 221 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 221 | ":ref:`overview-manual/concepts:automatically added runtime dependencies`" |
| 222 | section in the Yocto Project Overview and Concepts Manual. | 222 | section in the Yocto Project Overview and Concepts Manual. |
| 223 | 223 | ||
| 224 | .. _ref-tasks-package_qa: | 224 | .. _ref-tasks-package_qa: |
| @@ -237,7 +237,7 @@ see the :ref:`insane <ref-classes-insane>` class. | |||
| 237 | Creates Debian packages (i.e. ``*.deb`` files) and places them in the | 237 | Creates Debian packages (i.e. ``*.deb`` files) and places them in the |
| 238 | ``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in | 238 | ``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in |
| 239 | the package feeds area. For more information, see the | 239 | the package feeds area. For more information, see the |
| 240 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section in | 240 | ":ref:`overview-manual/concepts:package feeds`" section in |
| 241 | the Yocto Project Overview and Concepts Manual. | 241 | the Yocto Project Overview and Concepts Manual. |
| 242 | 242 | ||
| 243 | .. _ref-tasks-package_write_ipk: | 243 | .. _ref-tasks-package_write_ipk: |
| @@ -248,7 +248,7 @@ the Yocto Project Overview and Concepts Manual. | |||
| 248 | Creates IPK packages (i.e. ``*.ipk`` files) and places them in the | 248 | Creates IPK packages (i.e. ``*.ipk`` files) and places them in the |
| 249 | ``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in | 249 | ``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in |
| 250 | the package feeds area. For more information, see the | 250 | the package feeds area. For more information, see the |
| 251 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section in | 251 | ":ref:`overview-manual/concepts:package feeds`" section in |
| 252 | the Yocto Project Overview and Concepts Manual. | 252 | the Yocto Project Overview and Concepts Manual. |
| 253 | 253 | ||
| 254 | .. _ref-tasks-package_write_rpm: | 254 | .. _ref-tasks-package_write_rpm: |
| @@ -259,7 +259,7 @@ the Yocto Project Overview and Concepts Manual. | |||
| 259 | Creates RPM packages (i.e. ``*.rpm`` files) and places them in the | 259 | Creates RPM packages (i.e. ``*.rpm`` files) and places them in the |
| 260 | ``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in | 260 | ``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in |
| 261 | the package feeds area. For more information, see the | 261 | the package feeds area. For more information, see the |
| 262 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section in | 262 | ":ref:`overview-manual/concepts:package feeds`" section in |
| 263 | the Yocto Project Overview and Concepts Manual. | 263 | the Yocto Project Overview and Concepts Manual. |
| 264 | 264 | ||
| 265 | .. _ref-tasks-package_write_tar: | 265 | .. _ref-tasks-package_write_tar: |
| @@ -270,7 +270,7 @@ the Yocto Project Overview and Concepts Manual. | |||
| 270 | Creates tarballs and places them in the | 270 | Creates tarballs and places them in the |
| 271 | ``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in | 271 | ``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in |
| 272 | the package feeds area. For more information, see the | 272 | the package feeds area. For more information, see the |
| 273 | ":ref:`overview-manual/overview-manual-concepts:package feeds`" section in | 273 | ":ref:`overview-manual/concepts:package feeds`" section in |
| 274 | the Yocto Project Overview and Concepts Manual. | 274 | the Yocto Project Overview and Concepts Manual. |
| 275 | 275 | ||
| 276 | .. _ref-tasks-packagedata: | 276 | .. _ref-tasks-packagedata: |
| @@ -349,7 +349,7 @@ patch files end with either ``.patch`` or ``.diff``, every file would be | |||
| 349 | applied as a patch by default except for the ``patch_file5`` patch. | 349 | applied as a patch by default except for the ``patch_file5`` patch. |
| 350 | 350 | ||
| 351 | You can find out more about the patching process in the | 351 | You can find out more about the patching process in the |
| 352 | ":ref:`overview-manual/overview-manual-concepts:patching`" section in | 352 | ":ref:`overview-manual/concepts:patching`" section in |
| 353 | the Yocto Project Overview and Concepts Manual and the | 353 | the Yocto Project Overview and Concepts Manual and the |
| 354 | ":ref:`dev-manual/common-tasks:patching code`" section in the | 354 | ":ref:`dev-manual/common-tasks:patching code`" section in the |
| 355 | Yocto Project Development Tasks Manual. | 355 | Yocto Project Development Tasks Manual. |
| @@ -368,7 +368,7 @@ the image is constructed. | |||
| 368 | ------------------- | 368 | ------------------- |
| 369 | 369 | ||
| 370 | Creates the file and directory structure for an installable SDK. See the | 370 | Creates the file and directory structure for an installable SDK. See the |
| 371 | ":ref:`overview-manual/overview-manual-concepts:sdk generation`" | 371 | ":ref:`overview-manual/concepts:sdk generation`" |
| 372 | section in the Yocto Project Overview and Concepts Manual for more | 372 | section in the Yocto Project Overview and Concepts Manual for more |
| 373 | information. | 373 | information. |
| 374 | 374 | ||
| @@ -378,7 +378,7 @@ information. | |||
| 378 | ----------------------- | 378 | ----------------------- |
| 379 | 379 | ||
| 380 | Creates the file and directory structure for an installable extensible | 380 | Creates the file and directory structure for an installable extensible |
| 381 | SDK (eSDK). See the ":ref:`overview-manual/overview-manual-concepts:sdk generation`" | 381 | SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" |
| 382 | section in the Yocto Project Overview and Concepts Manual for more | 382 | section in the Yocto Project Overview and Concepts Manual for more |
| 383 | information. | 383 | information. |
| 384 | 384 | ||
| @@ -434,7 +434,7 @@ Unpacks the source code into a working directory pointed to by | |||
| 434 | ``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` | 434 | ``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` |
| 435 | variable also plays a role in where unpacked source files ultimately | 435 | variable also plays a role in where unpacked source files ultimately |
| 436 | reside. For more information on how source files are unpacked, see the | 436 | reside. For more information on how source files are unpacked, see the |
| 437 | ":ref:`overview-manual/overview-manual-concepts:source fetching`" | 437 | ":ref:`overview-manual/concepts:source fetching`" |
| 438 | section in the Yocto Project Overview and Concepts Manual and also see | 438 | section in the Yocto Project Overview and Concepts Manual and also see |
| 439 | the ``WORKDIR`` and ``S`` variable descriptions. | 439 | the ``WORKDIR`` and ``S`` variable descriptions. |
| 440 | 440 | ||
| @@ -500,7 +500,7 @@ You can run this task using BitBake as follows: | |||
| 500 | $ bitbake -c clean recipe | 500 | $ bitbake -c clean recipe |
| 501 | 501 | ||
| 502 | Running this task does not remove the | 502 | Running this task does not remove the |
| 503 | :ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>` cache files. | 503 | :ref:`sstate <overview-manual/concepts:shared state cache>` cache files. |
| 504 | Consequently, if no changes have been made and the recipe is rebuilt | 504 | Consequently, if no changes have been made and the recipe is rebuilt |
| 505 | after cleaning, output files are simply restored from the sstate cache. | 505 | after cleaning, output files are simply restored from the sstate cache. |
| 506 | If you want to remove the sstate cache files for the recipe, you need to | 506 | If you want to remove the sstate cache files for the recipe, you need to |
| @@ -513,7 +513,7 @@ use the :ref:`ref-tasks-cleansstate` task instead | |||
| 513 | --------------- | 513 | --------------- |
| 514 | 514 | ||
| 515 | Removes all output files, shared state | 515 | Removes all output files, shared state |
| 516 | (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache, and | 516 | (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache, and |
| 517 | downloaded source files for a target (i.e. the contents of | 517 | downloaded source files for a target (i.e. the contents of |
| 518 | :term:`DL_DIR`). Essentially, the ``do_cleanall`` task is | 518 | :term:`DL_DIR`). Essentially, the ``do_cleanall`` task is |
| 519 | identical to the :ref:`ref-tasks-cleansstate` task | 519 | identical to the :ref:`ref-tasks-cleansstate` task |
| @@ -534,10 +534,10 @@ task. | |||
| 534 | ------------------ | 534 | ------------------ |
| 535 | 535 | ||
| 536 | Removes all output files and shared state | 536 | Removes all output files and shared state |
| 537 | (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) cache for a | 537 | (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a |
| 538 | target. Essentially, the ``do_cleansstate`` task is identical to the | 538 | target. Essentially, the ``do_cleansstate`` task is identical to the |
| 539 | :ref:`ref-tasks-clean` task with the added removal of | 539 | :ref:`ref-tasks-clean` task with the added removal of |
| 540 | shared state (:ref:`sstate <overview-manual/overview-manual-concepts:shared state cache>`) | 540 | shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`) |
| 541 | cache. | 541 | cache. |
| 542 | 542 | ||
| 543 | You can run this task using BitBake as follows: | 543 | You can run this task using BitBake as follows: |
| @@ -593,7 +593,7 @@ Lists all defined tasks for a target. | |||
| 593 | ``do_package_index`` | 593 | ``do_package_index`` |
| 594 | -------------------- | 594 | -------------------- |
| 595 | 595 | ||
| 596 | Creates or updates the index in the :ref:`overview-manual/overview-manual-concepts:package feeds` area. | 596 | Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area. |
| 597 | 597 | ||
| 598 | .. note:: | 598 | .. note:: |
| 599 | 599 | ||
| @@ -631,7 +631,7 @@ has some more information about these types of images. | |||
| 631 | ------------- | 631 | ------------- |
| 632 | 632 | ||
| 633 | Creates the root filesystem (file and directory structure) for an image. | 633 | Creates the root filesystem (file and directory structure) for an image. |
| 634 | See the ":ref:`overview-manual/overview-manual-concepts:image generation`" | 634 | See the ":ref:`overview-manual/concepts:image generation`" |
| 635 | section in the Yocto Project Overview and Concepts Manual for more | 635 | section in the Yocto Project Overview and Concepts Manual for more |
| 636 | information on how the root filesystem is created. | 636 | information on how the root filesystem is created. |
| 637 | 637 | ||
