All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
From: "Quentin Schulz" <quentin.schulz@streamunlimited.com>
To: Daniel Wagenknecht <dwagenknecht@emlix.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH 1/2] ref-manual: variables: update examples refering to DEPLOY_DIR_IMAGE
Date: Fri, 11 Jun 2021 19:20:40 +0200	[thread overview]
Message-ID: <20210611172040.j7p3l6mln2mnfqss@qschulz> (raw)
In-Reply-To: <20210611062613.188300-2-dwagenknecht@emlix.com>

Hi Daniel,

On Fri, Jun 11, 2021 at 08:26:12AM +0200, Daniel Wagenknecht wrote:
> DEPLOY_DIR_IMAGE has been replaced by IMGDEPLOYDIR for most use cases
> since OE-Core rev 6d969bacc718e21a5246d4da9bf9639dcae29b02. Update
> examples given in the documentation to use IMGDEPLOYDIR and match their
> implementation.
> 
> Signed-off-by: Daniel Wagenknecht <dwagenknecht@emlix.com>
> ---
>  documentation/ref-manual/variables.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 8ebc17f24..2e859c718 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2946,7 +2946,7 @@ system and gives an overview of their function and contents.
>        an override for the associated type. Here is an example::
>  
>           IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \
> -             --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \
> +             --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}.rootfs.jffs2 \
>               ${EXTRA_IMAGECMD}"
>  

It'd be awesome if you could do a follow-up patch here since this isn't the actual
content of this variable anymore.
C.f.: https://cgit.openembedded.org/openembedded-core/tree/meta/classes/image_types.bbclass#n59

>        You typically do not need to set this variable unless you are adding
> @@ -3095,10 +3095,10 @@ system and gives an overview of their function and contents.
>        The :ref:`image <ref-classes-image>` class defines the manifest

IMAGE_MANIFEST isn't in this class anymore, it'd be great again if you
could send a follow-up patch for this.
c.f. http://cgit.openembedded.org/openembedded-core/tree/meta/classes/rootfs-postcommands.bbclass#n31

Thanks for the patch!

Reviewed-by: Quentin Schulz <foss@0leil.net>

[...]
>        The location is
> -      derived using the :term:`DEPLOY_DIR_IMAGE`
> +      derived using the :term:`IMGDEPLOYDIR`

On a side note: you should have added the term in the glossary (from patch 2)
first, because technically this commit does not build.

Cheers,
Quentin

  reply	other threads:[~2021-06-11 17:20 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   ` Quentin Schulz [this message]
2021-06-11  6:26 ` [PATCH 2/2] ref-manual: variables: document IMGDEPLOYDIR Daniel Wagenknecht
2021-06-11  6:46   ` [docs] " Nicolas Dechesne
2021-06-11  9:13     ` 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=20210611172040.j7p3l6mln2mnfqss@qschulz \
    --to=quentin.schulz@streamunlimited.com \
    --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.