From patchwork Mon Nov 2 09:22:58 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102666 Received: from smtpout-04.galae.net (smtpout-04.galae.net [185.171.202.116]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.8888.1793611418374412614 for ; Mon, 02 Nov 2026 01:23:39 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ycp0NaKc; spf=pass (domain: bootlin.com, ip: 185.171.202.116, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-04.galae.net (Postfix) with ESMTPS id C3B25C8F447; Mon, 2 Nov 2026 09:24:39 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id BEE0C60750; Mon, 2 Nov 2026 09:23:35 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id F3D121032911D; Mon, 2 Nov 2026 10:23:34 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793611415; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=qLzn2GhoxwDfAtv+aLdK6fFNsbUUkurqs7N/fR7Tn30=; b=ycp0NaKcMJKwb/kbuuJtcVRzqZOC4wLZMd2RuyTVSWI0phHWfiU88a+qu7LC9NMIS/QC9j f0rxM/WOXRmKNVEX0GGVw6f4bBK/zbk22bsG2khxph/yRbXIQvMD6SzTa/s6BAbGRS7L78 Dly0RRTs/l/eF9kUgogOo3aj6E28WnjKGIwDQO1h/2sGFjRMrcgPsSTPwRhvA+hFxYLWKi gusglz5oLcaxc6/lQ7j3gCXoIjFtHA78pyAk0Lk5tdemlHU480Jsc58LfiSO0KJU97BO/6 9ZOz0hF0ICsmpnWotfzACmr3PWltrYPlpUuLcK8k6CAnJyqTxAPkSm3V0Bv1hg== From: Antonin Godard Date: Mon, 02 Nov 2026 10:22:58 +0100 Subject: [PATCH 1/3] ref-manual/kickstart.rst: add a section for commands and directives MIME-Version: 1.0 Message-Id: <20261102-wks-in-v1-1-fbb797a3d5cb@bootlin.com> References: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> In-Reply-To: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Trevor Woerner , Antonin Godard X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=1569; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=qSakfsUVkNnziimGlo6O/cICOnITDlLImXXeFiB6iLo=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq6FZ0ULsSPOBd+sb2AoDzdSb3ebKRzBhe0D0yL FtEa/w0dIKJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauhWdAAKCRDRgEFAKaOo NhtcEACwXKhIQFdX0vzj/GTln0kY9SfPfXRNheXYjQhXdcLoxIJT4/BYWScTuFr6sHQKIC9Jog2 sH9bQmb94IHVZ/GgdAvYKtHd90FOKMWSw/DC7U4OBQk3kYO+/DU0ao8VCbWPm8JKGYgnHUTuoDW Gc0On3xMcWYnpuspCZl7+TZiEOGNJAlPH4iCunTzzGk4sFcur9xTZC3EmrTtb7uI52mhqL+4dOd h/JEcrZHFR9hieMg70uS8ndNVzS5v5GOt7AWpOMYnmpfyelSwlU89iqt7R0sXWaPHP2edR9Rpck NJdMIRICLT3NxCuKBo8rXmaRjLePf+80vSFYnSsp2iLDNlYsNYXAVK41G6YqV+I1YKXVXWGHNM1 wGdS3pi/e41u9pEJgAKl407vQMTfH40r2/ycEbbsIu65EnJnAE/2wfWskh1wTBc96QCjDe3CafC wIDrqHzNOfngov4t5hdUjx8FP1SmQoCr33Xbr2hc530QdDOJbdkT9u8h5jIdeGPLRQK+z1xBFlD JVYkpMUCX2V2fLaHPUOzL79fYYAHXez97Fu+/y+mUvjXk1Davx73HKhswQFMcuVicARB7l5wn0z 7ZREeWXGvj6zy6hgmahUpu/kLl9RjPOSZPRk8cnsawrAKDY013MTUe9X8aTZ+aZ+AvxNaIcmRG3 lqegj20jcyI77vw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Mon, 02 Nov 2026 09:23:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10755 In preparation for the next commits, add a new section for commands and directives so we can then create additional ones that cover other topics. Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 14aff6025..1144f1a12 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -16,8 +16,11 @@ modifications to reflect Wic capabilities. You can see the original documentation for those commands at the following link: https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html +Kickstart Commands And Directives +================================= + Command: part -============= +------------- This command creates a partition on the system and uses the following syntax:: @@ -202,7 +205,7 @@ the ``part`` command: ``wic help kickstart``). Command: bootloader -=================== +------------------- This command specifies how the bootloader should be configured and supports the following options: @@ -232,7 +235,7 @@ supports the following options: bootloader times out and boots the default option. Directive: include -================== +------------------ The ``include`` directive can be used to include a WKS file into another. The only argument to this command is the path to the file to include, relative to From patchwork Mon Nov 2 09:22:59 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102665 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.8889.1793611418554608567 for ; Mon, 02 Nov 2026 01:23:39 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=ExtkH3Ns; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id D61EB1A1406; Mon, 2 Nov 2026 09:23:36 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id A573860750; Mon, 2 Nov 2026 09:23:36 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A9A321032912A; Mon, 2 Nov 2026 10:23:35 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793611416; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=8QZS7KmW0xyu/ohy/hJDPgj3IMleCvX1pF0XoUVap4A=; b=ExtkH3NsBqGN2av6ey7OZ3FYBy1H2zn3t1+BXTlp4eI017PzMfJg0/S+Y95x4xW7/2ukpD +YUZ7sjVeXXQj5PGYeZKXfbnpGGiJ3oaDHc3MkkyGWQaFr0H141CGwwaQpCy6k/7wB6FKT 0V48H2Z5vySLCG25Fb5GAE9Gk4h4+rghp5PvqgtrOul1IK2zs1tbuT+Pkn/YktuIk/9qIS TOeYumd1k/2pggSGdcchdmVGLE+2m8IZEsqZ2xr/L2A/Y48gf+3DkgzE93ljsacyq9bOor jh4B1A5TMIHEB1RwYilBFd1Z9DZDamc06Y9htrk2RBE0hLYKItFS6H3RgWYLbw== From: Antonin Godard Date: Mon, 02 Nov 2026 10:22:59 +0100 Subject: [PATCH 2/3] ref-manual/kickstart.rst: warn about the include directive only working for .wks MIME-Version: 1.0 Message-Id: <20261102-wks-in-v1-2-fbb797a3d5cb@bootlin.com> References: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> In-Reply-To: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Trevor Woerner , Antonin Godard X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=872; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=ya9a4LTeHv9Y6z3bdOzoeuP/egCQMXGRJj8IPnA8sUM=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq6FZ0VDinBhgBr9KAHWSt4/RFufyUIbGd0NDBm M1lfCK8KJyJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauhWdAAKCRDRgEFAKaOo NsOvD/44744nOUIXJBtCxXXd03qOI50woNo2xwKH/jp1z3E+EVPyiC3sBWtbrBE5q2/3uxVOb+V bDvNZTXK6XmJt6gGrouk+a24x0tYXC/hzUMommtKUSM6rugIyXflc305l4RDvcDMla3uDLw++zD O8B+pyQpDD1rrZT0qrHaw8V8D4fxCBig3durDI3HAI0Jb1oz+/RyOAwiwqQ0e0HNs46+uQK3bUz sMGd+POcCwDaBRWfSFxJajbpH6BAjJ/s2xR5+QKkqs9jOLUEOrnXH7wh0jW9pVyd2f4Jbp6McZ4 TrOYep+FmnF5EcbDwV5CM5KxoRUa9WjgGtr/KOJUoRfeicfEYP7+pYN4aqnz6A7jnC90i3QrKHU jKhEekum2UoG816/cEh/MLdMHqIEHt5kbhiZrpSt0V5g1lPaxTXDjvPCyFdh74tCaj7b2YnlxGq Rk/ogCm60YrbcVwMKIuCUhQ858J6xNEkCaGXp/0sodFCIIc7ce5+HCCHKQkXRDushti6OTYIILq e8PZliegZt+0qOcjHe3rGt7qBrEjjNhkLNxw/C1uqvB+wkwvAuXV4jvU6mUfgJjvQqGnPxm4/JD rgx8T5gLINfAXdAD5idWSUIKv93+OWg2uiqLR2+tnNV4RAdFNKNKBG9f8KNSGfM29iRhkIJR9xS 4THv+a0mfgVsjvw== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Mon, 02 Nov 2026 09:23:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10754 The include directive only works for .wks files, not .wks.in. Document this limitation. Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 1144f1a12..5223b80a9 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -246,3 +246,9 @@ the current file. For example: include common.wks.inc bootloader --configfile="directdisk-bootloader-config.cfg" + +.. warning:: + + File inclusion is only supported for ``.wks`` files, not ``.wks.in``. See the + :ref:`ref-manual/kickstart:Kickstart Variable Expansion` section below for + more details on the differences between the two files. From patchwork Mon Nov 2 09:23:00 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 102664 Received: from smtpout-02.galae.net (smtpout-02.galae.net [185.246.84.56]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.9097.1793611419290653942 for ; Mon, 02 Nov 2026 01:23:39 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="dkim: body hash did not verify" header.i=@bootlin.com header.s=dkim header.b=UJr7kbIM; spf=pass (domain: bootlin.com, ip: 185.246.84.56, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-02.galae.net (Postfix) with ESMTPS id A59FE1A140C for ; Mon, 2 Nov 2026 09:23:37 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 7483A60750; Mon, 2 Nov 2026 09:23:37 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 82F3F10329134; Mon, 2 Nov 2026 10:23:36 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1793611416; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=/Q7lYSpRTJW/ZItWV+OYPyx/0xNO7vzeaRbC+8dJlnA=; b=UJr7kbIM4gVqFogko0NO9A3VPVqOLJwYQ+jMHg7SDMVsmVeI9iCI/CuNBx/STSkzjhYe9k eIQXXaPkEvtO42D0hy4PB9Wh1RbdlCJ3wnbLKNGunvC2x4cB9XHXICLU2PMR6FhXI9RJZJ JJ4wJLX5KIyqSlS6U1NSWjPNf1dCDGZfzyIsmRvBjA2gNp1gqNqm/C+2u/Zuhm7pnxrwqP Q5tksKnH6to9ksWTag5S05w8F0e9KHldeXIFTAUjEi/efbypKwPkICRfpzuC0/0Thz9oxA KluoXZLJRLV+D7eHLoI599ebcyHbhRRwQz6rhwCqlCiKl5z6xQkBAeChoKDx1A== From: Antonin Godard Date: Mon, 02 Nov 2026 10:23:00 +0100 Subject: [PATCH 3/3] ref-manual/kickstart.rst: document location and variable expansion MIME-Version: 1.0 Message-Id: <20261102-wks-in-v1-3-fbb797a3d5cb@bootlin.com> References: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> In-Reply-To: <20261102-wks-in-v1-0-fbb797a3d5cb@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Trevor Woerner , Antonin Godard X-Mailer: b4 0.17-dev X-Developer-Signature: v=1; a=openpgp-sha256; l=7321; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=iWMHfCtXK+sAeN4RtFKXY3lFbxg2eVXN3xUDa5Yz0A8=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBq6FZ00LVLlSpvHUgv2jE8/duLtgOqwuyZBGt99 9FwJEm/EySJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCauhWdAAKCRDRgEFAKaOo NlpfD/9aVaOuHHubVfCcMJ0FrGylqidueST1gno50IqguLarIzL0B5AQDkkw0LW0xFP5Ovv416B rVxX5YwWwFHMlSysac+YObKu1m11js5FBJl5+qtR9haoh4/igT/lTnIMacjKXSjBOWse/zOzHdT OJ7JOPx2/XhxUu3SG6p7ISWl9XqBkW5+N9V5fteU2fUujysdMNM0u+/HHuaIe1tHJBdg5MJXcKm LiOnb3wbPTshlJUDY2d9qEOUtAVa0fdi3incL8t/MF1pHUMAP97E97ZsfUnhFFr1uaCALQBSd3N 7pDL/7N9ljtNciTH4mwhDK8PZjMq2+xzhm/WBfxdE/CeBoqLWhTN2lOJ/ee0jcb+SmEPu7o7Z+P 9jgZpWjy+pMAhkTuk/wWNyDF4gW0AVE5J4lhycOIw47hfPs96zdPbGMypDTjKMYCrF8MSZXAfWn NnTUXaskiNU7+FQ3rJGIxBIXfRqk7DADVr2LRGDSP4ag6XRegUFgob9JXteBjD1BMqTPAxSnQoc yo7Ktq1WTz4zj/k32aTeqM/c+HjqNRhp/6OH2BZSTe7h8OTA/OiGMagiksCrK3SjRRs9geTszOv fSJE/z0qOcgJLl5yxQRcZOCQ+DNYNiEPmbEvWYwT4KULpMQDGhowFe9yG3FQsUHe1n0+8UukOLS yi3cEOAY420+erA== X-Developer-Key: i=antonin.godard@bootlin.com; a=openpgp; fpr=8648725188DD401BB9A0D3FFD180414029A3A836 X-Last-TLS-Session-Version: TLSv1.3 List-Id: X-Webhook-Received: from 45-33-107-173.ip.linodeusercontent.com [45.33.107.173] by lin-tor-korg-lkml-alma10-1 with HTTPS for ; Mon, 02 Nov 2026 09:23:45 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/10756 Expand the kickstart reference documentation with: - Details on kickstart files expected location. - Details on variable expansion and differences between .wks/.wks.in. - Documentation for the WICVARS variable. [YOCTO #16432] Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 125 ++++++++++++++++++++++++++++++++- documentation/ref-manual/variables.rst | 8 +++ 2 files changed, 132 insertions(+), 1 deletion(-) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 5223b80a9..8d5e9f317 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -9,13 +9,47 @@ OpenEmbedded Kickstart (``.wks``) Reference Introduction ============ -This chapter provides a reference on the available kickstart commands. +This chapter provides a reference on the available kickstart commands and +variable expansion in kickstart files (``.wks`` and ``.wks.in`` files). The information lists the commands, their syntax, and meanings. Kickstart commands are based on the Fedora kickstart versions but with modifications to reflect Wic capabilities. You can see the original documentation for those commands at the following link: https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html +Kickstart Files Location +======================== + +Within a :term:`layer`, a kickstart file should always be placed in the +``files/wic`` directory. For example, as of writing, the +:term:`OpenEmbedded-Core (OE-Core)` layer has the following files: + +.. code-block:: text + + meta/files/wic + ├── common.wks.inc + ├── directdisk-bootloader-config.cfg + ├── directdisk-bootloader-config.wks + ├── directdisk-gpt.wks + ├── directdisk-multi-rootfs.wks + ├── directdisk.wks + ├── efi-bootdisk.wks.in + ├── efi-uki-bootdisk.wks.in + ├── mkefidisk.wks + ├── mkhybridiso.wks + ├── qemuloongarch.wks + ├── qemuriscv.wks + ├── qemux86-directdisk.wks + ├── sdimage-bootpart.wks + └── systemd-bootdisk.wks + +Kickstart files within this directory can end with ``.wks`` and ``.wks.in`` (see +the :ref:`ref-manual/kickstart:Kickstart Variable Expansion` section for more +details on the differences). Files ending with ``.inc`` are files included in +kickstart files (see the :ref:`ref-manual/kickstart:Directive: include` +section), and the ``.cfg`` is a configuration file used by the :ref:`bootloader +` command. + Kickstart Commands And Directives ================================= @@ -252,3 +286,92 @@ the current file. For example: File inclusion is only supported for ``.wks`` files, not ``.wks.in``. See the :ref:`ref-manual/kickstart:Kickstart Variable Expansion` section below for more details on the differences between the two files. + +Kickstart Variable Expansion +============================ + +Kickstart files support two different file extensions and each has a different +variable expansion mechanism: + +- ``.wks``: in this file format, only the variables listed in the + :term:`WICVARS` variable are expanded. These variables are expanded by the + :term:`wic` command-line utility, not :term:`BitBake`. However, the syntax to + reference these variables is the same. For example: + + .. code-block:: text + :caption: Snippet from ``mkefidisk.wks`` + + bootloader --ptable gpt --timeout=5 --append="rootfstype=ext4 console=${KERNEL_CONSOLE} console=tty0" + + Here, the :term:`KERNEL_CONSOLE` variable will be expanded, because it is in + :term:`WICVARS`. + + For any referenced variable that is not listed in :term:`WICVARS`, a warning + is emitted (by the :term:`wic` command-line tool, not :term:`BitBake`), and + the ``${...}`` string is left as-is. + + .. note:: + + The :term:`wic` command-line utility is a separate project (see + :yocto_git:`/wic`). It is for this reason that the :term:`wic` tool + supports expanding variables without :term:`BitBake`, using its own + mechanism. + +- ``.wks.in``: in this file format, variables are expanded by :term:`BitBake`. + This means that the :term:`WICVARS` list has no effect anymore: those + variables are expanded by :term:`BitBake` directly. For example: + + .. code-block:: text + :caption: Snippet from ``efi-uki-bootdisk.wks.in`` + + part /boot --source bootimg_efi --sourceparams="loader=${EFI_PROVIDER}" --label boot --active ... + + Here, the :term:`EFI_PROVIDER` variable is expanded by :term:`BitBake`. + + This also means that ``.wks.in`` files can contain inline Python expressions. + Here is a made up example: + + .. code-block:: text + + part / --source rootfs --fstype=ext4 --label root --align ${@4 * 1024} --size 5G + + Here, since the ``${@4 * 1024}`` expression is evaluated by :term:`BitBake`, + it will be expanded to ``4096``. + + For any referenced variable that is not defined in the environment, an empty + string replaces the reference. + +Here is a table that summarizes expansion results between ``.wks`` and ``.wks.in``: + +.. list-table:: + :widths: 20 20 40 40 + :header-rows: 1 + + * - Reference + - In :term:`WICVARS`? + - ``.wks`` (:term:`Wic` expansion) + - ``.wks.in`` (:term:`BitBake` expansion) + * - ``${IMAGE_ROOTFS}`` + - yes + - ``/path/to/rootfs`` + - ``/path/to/rootfs`` + * - ``${TMPDIR}`` + - no + - ``${TMPDIR}`` + - ``/path/to/build/tmp`` + * - ``${@1024*2}`` + - n/a + - ``${@1024*2}`` + - 2048 + * - ``${NOWHERE_DEFINED}`` + - no + - ``${NOWHERE_DEFINED}`` + - (empty) + +Expansion in Included Files +--------------------------- + +For files that are included with the :ref:`include +` directive presented above, variable +expansion is *always* done by :term:`wic`'s own parser, using the +:term:`WICVARS` variable. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index bbf0e6d07..2e01d0422 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -12774,6 +12774,14 @@ system and gives an overview of their function and contents. ":ref:`dev-manual/wic:creating partitioned images using wic`" section in the Yocto Project Development Tasks Manual. + :term:`WICVARS` + Defined in the :ref:`image_types_wic ` class, the + :term:`WICVARS` variable contains a list of variable names that can be + used in :doc:`.wks ` files. ``.wks`` files differ + from ``.wks.in`` files: for the latter, variables are expanded by + :term:`BitBake` instead. For more details, see the + :ref:`ref-manual/kickstart:Kickstart Variable Expansion` section. + :term:`WIRELESS_DAEMON` For ``connman`` and ``packagegroup-base``, specifies the wireless daemon to use. The default is "wpa-supplicant" (note that the value