[PATCH v3] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS

[PATCH v3] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS

[Trevor Woerner]

Fixes [YOCTO #15509]

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
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
+      command which allows the user to supply additional arguments.
+
+      One such useful purpose for this mechanism is to add the `-D` (or
+      `--debug`) argument to the "`wic create`" command. This increases the
+      amount of debugging information written out to the Wic log during the
+      Wic creation process.
+
    :term:`WIC_SECTOR_SIZE`
       The variable :term:`WIC_SECTOR_SIZE` controls the sector size of Wic
       images. In the background, this controls the value of the
-- 
2.44.0.501.g19981daefd7c

Re: [docs] [PATCH v3] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS

[Quentin Schulz]

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