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 | |
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>
-rw-r--r-- | documentation/migration-guides/migration-3.2.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 18 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
4 files changed, 16 insertions, 16 deletions
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index 8d251deaf7..a714bd6bca 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -207,9 +207,9 @@ files into a subdirectory and reference that instead. | |||
207 | deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` | 207 | deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` |
208 | ---------------------------------------------------------- | 208 | ---------------------------------------------------------- |
209 | 209 | ||
210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. | 210 | :ref:`ref-tasks-deploy` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. |
211 | 211 | ||
212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. | 212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. |
213 | 213 | ||
214 | 214 | ||
215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: | 215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 06220401bc..f3f8cbd95c 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -1801,14 +1801,14 @@ from the :ref:`deploy <ref-classes-deploy>` class:: | |||
1801 | 1801 | ||
1802 | The following list explains the previous example: | 1802 | The following list explains the previous example: |
1803 | 1803 | ||
1804 | - Adding "do_deploy" to ``SSTATETASKS`` adds some required | 1804 | - Adding ``do_deploy`` to ``SSTATETASKS`` adds some required |
1805 | sstate-related processing, which is implemented in the | 1805 | sstate-related processing, which is implemented in the |
1806 | :ref:`sstate <ref-classes-sstate>` class, to | 1806 | :ref:`sstate <ref-classes-sstate>` class, to |
1807 | before and after the | 1807 | before and after the |
1808 | :ref:`ref-tasks-deploy` task. | 1808 | :ref:`ref-tasks-deploy` task. |
1809 | 1809 | ||
1810 | - The ``do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"`` declares that | 1810 | - The ``do_deploy[sstate-inputdirs] = "${DEPLOYDIR}"`` declares that |
1811 | ``do_deploy`` places its output in ``${DEPLOYDIR}`` when run normally | 1811 | :ref:`ref-tasks-deploy` places its output in ``${DEPLOYDIR}`` when run normally |
1812 | (i.e. when not using the sstate cache). This output becomes the input | 1812 | (i.e. when not using the sstate cache). This output becomes the input |
1813 | to the shared state cache. | 1813 | to the shared state cache. |
1814 | 1814 | ||
@@ -1818,15 +1818,15 @@ The following list explains the previous example: | |||
1818 | 1818 | ||
1819 | .. note:: | 1819 | .. note:: |
1820 | 1820 | ||
1821 | If ``do_deploy`` is not already in the shared state cache or if its input | 1821 | If :ref:`ref-tasks-deploy` is not already in the shared state cache or if its input |
1822 | checksum (signature) has changed from when the output was cached, the task | 1822 | checksum (signature) has changed from when the output was cached, the task |
1823 | runs to populate the shared state cache, after which the contents of the | 1823 | runs to populate the shared state cache, after which the contents of the |
1824 | shared state cache is copied to ${:term:`DEPLOY_DIR_IMAGE`}. If | 1824 | shared state cache is copied to ${:term:`DEPLOY_DIR_IMAGE`}. If |
1825 | ``do_deploy`` is in the shared state cache and its signature indicates | 1825 | :ref:`ref-tasks-deploy` is in the shared state cache and its signature indicates |
1826 | that the cached output is still valid (i.e. if no relevant task inputs | 1826 | that the cached output is still valid (i.e. if no relevant task inputs |
1827 | have changed), then the contents of the shared state cache copies | 1827 | have changed), then the contents of the shared state cache copies |
1828 | directly to ${:term:`DEPLOY_DIR_IMAGE`} by the ``do_deploy_setscene`` task | 1828 | directly to ${:term:`DEPLOY_DIR_IMAGE`} by the ``do_deploy_setscene`` task |
1829 | instead, skipping the ``do_deploy`` task. | 1829 | instead, skipping the :ref:`ref-tasks-deploy` task. |
1830 | 1830 | ||
1831 | - The following task definition is glue logic needed to make the | 1831 | - The following task definition is glue logic needed to make the |
1832 | previous settings effective:: | 1832 | previous settings effective:: |
@@ -1836,16 +1836,16 @@ The following list explains the previous example: | |||
1836 | } | 1836 | } |
1837 | addtask do_deploy_setscene | 1837 | addtask do_deploy_setscene |
1838 | 1838 | ||
1839 | ``sstate_setscene()`` takes the flags above as input and accelerates the ``do_deploy`` task | 1839 | ``sstate_setscene()`` takes the flags above as input and accelerates the :ref:`ref-tasks-deploy` task |
1840 | through the shared state cache if possible. If the task was | 1840 | through the shared state cache if possible. If the task was |
1841 | accelerated, ``sstate_setscene()`` returns True. Otherwise, it | 1841 | accelerated, ``sstate_setscene()`` returns True. Otherwise, it |
1842 | returns False, and the normal ``do_deploy`` task runs. For more | 1842 | returns False, and the normal :ref:`ref-tasks-deploy` task runs. For more |
1843 | information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" | 1843 | information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-execution:setscene`" |
1844 | section in the BitBake User Manual. | 1844 | section in the BitBake User Manual. |
1845 | 1845 | ||
1846 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates | 1846 | - The ``do_deploy[dirs] = "${DEPLOYDIR} ${B}"`` line creates |
1847 | ``${DEPLOYDIR}`` and ``${B}`` before the ``do_deploy`` task runs, and | 1847 | ``${DEPLOYDIR}`` and ``${B}`` before the :ref:`ref-tasks-deploy` task runs, and |
1848 | also sets the current working directory of ``do_deploy`` to ``${B}``. | 1848 | also sets the current working directory of :ref:`ref-tasks-deploy` to ``${B}``. |
1849 | For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" | 1849 | For more information, see the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" |
1850 | section in the BitBake | 1850 | section in the BitBake |
1851 | User Manual. | 1851 | User Manual. |
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 |