diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/variables.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 2e859c7184..ee10431089 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -1673,6 +1673,13 @@ system and gives an overview of their function and contents. | |||
1673 | resides within the :term:`Build Directory` as | 1673 | resides within the :term:`Build Directory` as |
1674 | ``${DEPLOY_DIR}/images/${MACHINE}/``. | 1674 | ``${DEPLOY_DIR}/images/${MACHINE}/``. |
1675 | 1675 | ||
1676 | It must not be used directly in recipes when deploying files. Instead, | ||
1677 | it's only useful when a recipe needs to "read" a file already deployed | ||
1678 | by a dependency. So, it should be filled with the contents of | ||
1679 | :term:`DEPLOYDIR` by the :ref:`deploy <ref-classes-deploy>` class or | ||
1680 | with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image | ||
1681 | <ref-classes-image>` class. | ||
1682 | |||
1676 | For more information on the structure of the Build Directory, see | 1683 | For more information on the structure of the Build Directory, see |
1677 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1684 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. |
1678 | For more detail on the contents of the ``deploy`` directory, see the | 1685 | For more detail on the contents of the ``deploy`` directory, see the |
@@ -3324,6 +3331,18 @@ system and gives an overview of their function and contents. | |||
3324 | desired, and this suffix would then be used consistently across | 3331 | desired, and this suffix would then be used consistently across |
3325 | the build artifacts. | 3332 | the build artifacts. |
3326 | 3333 | ||
3334 | :term:`IMGDEPLOYDIR` | ||
3335 | When inheriting the :ref:`image <ref-classes-image>` class directly or | ||
3336 | through the :ref:`core-image <ref-classes-core-image>` class, the | ||
3337 | ``IMGDEPLOYDIR`` points to a temporary work area for deployed files | ||
3338 | that is set in the ``image`` class as follows:: | ||
3339 | |||
3340 | IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" | ||
3341 | |||
3342 | Recipes inheriting the ``image`` class should copy files to be | ||
3343 | deployed into ``IMGDEPLOYDIR``, and the class will take care of | ||
3344 | copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. | ||
3345 | |||
3327 | :term:`INC_PR` | 3346 | :term:`INC_PR` |
3328 | Helps define the recipe revision for recipes that share a common | 3347 | Helps define the recipe revision for recipes that share a common |
3329 | ``include`` file. You can think of this variable as part of the | 3348 | ``include`` file. You can think of this variable as part of the |