public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS
Date: Tue,  6 May 2025 13:23:00 -0400	[thread overview]
Message-ID: <20250506172300.19220-1-twoerner@gmail.com> (raw)

Fixes [YOCTO #15509]

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

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
-- 
2.44.0.501.g19981daefd7c



             reply	other threads:[~2025-05-06 17:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-06 17:23 Trevor Woerner [this message]
2025-05-12  7:31 ` [docs] [PATCH] ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS Quentin Schulz
2025-05-12 21:01   ` Trevor Woerner
2025-05-13  7:59     ` Quentin Schulz
2025-05-13 13:14       ` Trevor Woerner

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=20250506172300.19220-1-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox