diff mbox series

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

Message ID 20250513165839.31473-1-twoerner@gmail.com
State New
Headers show
Series [v4] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS | expand

Commit Message

Trevor Woerner May 13, 2025, 4:58 p.m. UTC 
Fixes [YOCTO #15509]

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
changes in v4:
- added collected git tags
- add self-referencing :term: link for the term being defined

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 mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d17f81036b7d..a10c5e009623 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
+      :term:`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