From: "Nicolas Dechesne" <nicolas.dechesne@linaro.org>
To: Daniel Wagenknecht <dwagenknecht@emlix.com>
Cc: YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH 2/2] ref-manual: variables: document IMGDEPLOYDIR
Date: Fri, 11 Jun 2021 08:46:40 +0200 [thread overview]
Message-ID: <CAP71WjxGyxR=2tTK8LyVrmPsOX4rd9_NsOTMbEYfr+kTH4UoLw@mail.gmail.com> (raw)
In-Reply-To: <20210611062613.188300-3-dwagenknecht@emlix.com>
[-- Attachment #1: Type: text/plain, Size: 2832 bytes --]
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
>
>
>
>
>
[-- Attachment #2: Type: text/html, Size: 3910 bytes --]
next prev parent reply other threads:[~2021-06-11 6:46 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-11 6:26 [PATCH 0/2] ref-manual: variables: document IMGDEPLOYDIR Daniel Wagenknecht
2021-06-11 6:26 ` [PATCH 1/2] ref-manual: variables: update examples refering to DEPLOY_DIR_IMAGE Daniel Wagenknecht
2021-06-11 17:20 ` [docs] " Quentin Schulz
2021-06-11 6:26 ` [PATCH 2/2] ref-manual: variables: document IMGDEPLOYDIR Daniel Wagenknecht
2021-06-11 6:46 ` Nicolas Dechesne [this message]
2021-06-11 9:13 ` [docs] " Michael Opdenacker
2021-06-11 10:14 ` Daniel Wagenknecht
2021-06-11 16:24 ` Michael Opdenacker
2021-06-11 7:30 ` [PATCH 3/3] ref-manual: migration-2.2: add note about IMGDEPLOYDIR Daniel Wagenknecht
2021-06-11 9:16 ` [docs] [PATCH 2/2] ref-manual: variables: document IMGDEPLOYDIR Michael Opdenacker
2021-06-11 6:48 ` [docs] [PATCH 0/2] " Nicolas Dechesne
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAP71WjxGyxR=2tTK8LyVrmPsOX4rd9_NsOTMbEYfr+kTH4UoLw@mail.gmail.com' \
--to=nicolas.dechesne@linaro.org \
--cc=docs@lists.yoctoproject.org \
--cc=dwagenknecht@emlix.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.