diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-09-23 17:51:03 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-07 10:54:25 +0100 |
| commit | 0e8d0ecc6ce511bacc59d06214d6e53ee4dceaad (patch) | |
| tree | 4200fac9e693c731ef09c793878b55062ebb462a /documentation/ref-manual | |
| parent | 6ade5d2d0ea95731c629af83d2d990ab86048d20 (diff) | |
| download | poky-0e8d0ecc6ce511bacc59d06214d6e53ee4dceaad.tar.gz | |
manuals: add references to the "do_deploy" task
[YOCTO #14508]
Reported-by: Quentin Schulz <foss@0leil.net>
(From yocto-docs rev: b607a0578e8edd3e4ee013b4438481cb82bc106e)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/tasks.rst | 8 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
2 files changed, 5 insertions, 5 deletions
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 8cffbb16c8..f47a30e467 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
| @@ -81,7 +81,7 @@ Recipes implementing this task should inherit the | |||
| 81 | :ref:`deploy <ref-classes-deploy>` class and should write the output | 81 | :ref:`deploy <ref-classes-deploy>` class and should write the output |
| 82 | to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be | 82 | to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be |
| 83 | confused with ``${DEPLOY_DIR}``. The :ref:`deploy <ref-classes-deploy>` class sets up | 83 | confused with ``${DEPLOY_DIR}``. The :ref:`deploy <ref-classes-deploy>` class sets up |
| 84 | ``do_deploy`` as a shared state (sstate) task that can be accelerated | 84 | :ref:`ref-tasks-deploy` as a shared state (sstate) task that can be accelerated |
| 85 | through sstate use. The sstate mechanism takes care of copying the | 85 | through sstate use. The sstate mechanism takes care of copying the |
| 86 | output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. | 86 | output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. |
| 87 | 87 | ||
| @@ -90,14 +90,14 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. | |||
| 90 | Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes | 90 | Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes |
| 91 | the sstate mechanism to malfunction. | 91 | the sstate mechanism to malfunction. |
| 92 | 92 | ||
| 93 | The ``do_deploy`` task is not added as a task by default and | 93 | The :ref:`ref-tasks-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 | 97 | ||
| 98 | addtask deploy after do_compile | 98 | addtask deploy after do_compile |
| 99 | 99 | ||
| 100 | Adding ``do_deploy`` after other tasks works the same way. | 100 | Adding :ref:`ref-tasks-deploy` after other tasks works the same way. |
| 101 | 101 | ||
| 102 | .. note:: | 102 | .. note:: |
| 103 | 103 | ||
| @@ -110,7 +110,7 @@ Adding ``do_deploy`` after other tasks works the same way. | |||
| 110 | See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" | 110 | See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" |
| 111 | section in the BitBake User Manual for more information. | 111 | section in the BitBake User Manual for more information. |
| 112 | 112 | ||
| 113 | If the ``do_deploy`` task re-executes, any previous output is removed | 113 | If the :ref:`ref-tasks-deploy` task re-executes, any previous output is removed |
| 114 | (i.e. "cleaned"). | 114 | (i.e. "cleaned"). |
| 115 | 115 | ||
| 116 | .. _ref-tasks-fetch: | 116 | .. _ref-tasks-fetch: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c6d058661a..00156cee94 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -6754,7 +6754,7 @@ system and gives an overview of their function and contents. | |||
| 6754 | - do_populate_lic | 6754 | - do_populate_lic |
| 6755 | - do_package_qa | 6755 | - do_package_qa |
| 6756 | - do_populate_sysroot | 6756 | - do_populate_sysroot |
| 6757 | - do_deploy | 6757 | - :ref:`ref-tasks-deploy` |
| 6758 | 6758 | ||
| 6759 | Despite the default value of "" for the | 6759 | Despite the default value of "" for the |
| 6760 | :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added | 6760 | :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added |
