On Fri, Jun 11, 2021 at 8:26 AM Daniel Wagenknecht <dwagenknecht@emlix.com>
wrote:

> DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
> since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Document
> IMGDEPLOYDIR and add a note to DEPLOY_DIR_IMAGE about it.
>

It's a really good idea to document that better, I've had to explain that a
few times, and it's not very intuitive for someone not familiar with how
sstate works.
Thanks!


>
> Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
> ---
>  documentation/ref-manual/variables.rst | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>
> diff --git a/documentation/ref-manual/variables.rst
> b/documentation/ref-manual/variables.rst
> index 2e859c718..8b41a1fe1 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -1673,6 +1673,11 @@ system and gives an overview of their function and
> contents.
>        resides within the :term:`Build Directory` as
>        ``${DEPLOY_DIR}/images/${MACHINE}/``.
>
> +      It is usually not used directly in recipes, but filled with the
> contents
> +      of :term:`DEPLOYDIR` by the :ref:`deploy <ref-classes-deploy>`
> class or
> +      with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image
> +      <ref-classes-image>` class.
>

The message should be even stronger. It *must* not be used in recipes when
deploying files. It can be used only when a recipe need to 'read' a file
already deployed by a dependency of course.



> +
>        For more information on the structure of the Build Directory, see
>        ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``"
> section.
>        For more detail on the contents of the ``deploy`` directory, see the
> @@ -3324,6 +3329,18 @@ system and gives an overview of their function and
> contents.
>        desired, and this suffix would then be used consistently across
>        the build artifacts.
>
> +   :term:`IMGDEPLOYDIR`
> +      When inheriting the :ref:`image <ref-classes-image>` directly or
> +      through the :ref:`core-image <ref-classes-core-image>` class, the
> +      ``IMGDEPLOYDIR`` points to a temporary work area for deployed files
> +      that is set in the ``image`` class as follows::
> +
> +         IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
> +
> +      Recipes inheriting the ``image`` class should copy files to be
> +      deployed into ``IMGDEPLOYDIR``, and the class will take care of
> +      copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
>
+
>     :term:`INC_PR`
>        Helps define the recipe revision for recipes that share a common
>        ``include`` file. You can think of this variable as part of the
> --
> 2.25.1
>
>
> 
>
>