All of lore.kernel.org
 help / color / mirror / Atom feed
From: Quentin Schulz <quentin.schulz@cherry.de>
To: twoerner@gmail.com, docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH v3] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS
Date: Tue, 13 May 2025 17:37:00 +0200	[thread overview]
Message-ID: <7a5e1e18-02ad-41de-aee0-3a00a35ec0be@cherry.de> (raw)
In-Reply-To: <20250513144803.26956-1-twoerner@gmail.com>

Hi Trevor,

On 5/13/25 4:48 PM, Trevor Woerner via lists.yoctoproject.org wrote:
> Fixes [YOCTO #15509]
> 
> Signed-off-by: Trevor Woerner <twoerner@gmail.com>

Try to add Reviewed-by trailers to the commit logs when they are given 
on earlier versions :)

> ---
> changes in v3:
> - add tickquotes for -D and --debug
> 
> changes in v2:
> - link the phrase "Wic image" to the dev manual's section on creating wic
>    images instead of providing a paragraph at the end to include the link
> - remove any reference to a bbclass
> - reduce the number of "`wic create`" phrases
> ---
>   documentation/ref-manual/variables.rst | 14 ++++++++++++++
>   1 file changed, 14 insertions(+)
> 
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index d17f81036b7d..670cb3e0ef28 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -10942,6 +10942,20 @@ system and gives an overview of their function and contents.
>         Specifies the timeout in seconds used by the ``watchdog-config`` recipe
>         and also by ``systemd`` during reboot. The default is 60 seconds.
>   
> +   :term:`WIC_CREATE_EXTRA_ARGS`
> +      If the :term:`IMAGE_FSTYPES` variable contains "wic", the build
> +      will generate a
> +      :ref:`Wic image <dev-manual/wic:creating partitioned images using wic>`
> +      automatically when BitBake builds an image recipe. As part of this
> +      process BitBake will invoke the "`wic create`" command.
> +      The `WIC_CREATE_EXTRA_ARGS` variable is placed at the end of this

We always refer (or at least should always refer) to documented 
variables with :term:`WIC_CREATE_EXTRA_ARGS` so that a link exists. Yes, 
even in the same section it is documented.

Cheers,
Quentin


      reply	other threads:[~2025-05-13 15:37 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-13 14:48 [PATCH v3] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS Trevor Woerner
2025-05-13 15:37 ` Quentin Schulz [this message]

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=7a5e1e18-02ad-41de-aee0-3a00a35ec0be@cherry.de \
    --to=quentin.schulz@cherry.de \
    --cc=docs@lists.yoctoproject.org \
    --cc=twoerner@gmail.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.