diff mbox series

ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS

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

Commit Message

Trevor Woerner May 6, 2025, 5:23 p.m. UTC
Fixes [YOCTO #15509]

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 documentation/ref-manual/variables.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d17f81036b7d..29f34f5b029d 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -10942,6 +10942,24 @@  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 Wic image automatically when BitBake builds an
+      image recipe. As part of this process the Wic bbclass will call the
+      "`wic create`" command. The `WIC_CREATE_EXTRA_ARGS` variable is
+      appended to the internal "`wic create`" command to provide a
+      mechanism for the user to supply extra arguments to the
+      "`wic create`" command that is automatically run by BitBake.
+
+      One such useful purpose for this mechanism is to add the "-D|--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.
+
+      For more information about creating Wic images, see the
+      ":ref:`dev-manual/wic:creating partitioned images using wic`" section in
+      the Yocto Project Development Tasks Manual.
+
    :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