From patchwork Thu Jun 25 09:33:28 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90977 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id D3822CDE00F for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.7328.1782380026159100368 for ; Thu, 25 Jun 2026 02:33:47 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=JU4c6tga; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 7D7D74E408D1 for ; Thu, 25 Jun 2026 09:33:44 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 544505FF03 for ; Thu, 25 Jun 2026 09:33:44 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 9D866106F07A9; Thu, 25 Jun 2026 11:33:43 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380023; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=ycXBoAkBWqpJTdh4xYYUKmBP3P9k7O3orRF2JNyCrgg=; b=JU4c6tgaOZUuo5q+aFsK7/IbggYqSN+lefzTWVWyvCldnF0g2OC+VdOIaFg14bp9eDDze2 rpcg6NmQZqfmgWd4Y2tCXGYfilnQ0OWsekwj4mFDZQ/kQSf4kdNis/eBmSnQT7CSjB6RvK hgokZypPWGP04uLN1Uz0THxXoz9Jqe5cYIShiAO9q3qlSCe7YPP99CyKewcIco923MduRx c1H1EYVMr5kV4ru3RpS0BYe1JbYD+pfJfria/Ck0lY6hK1DbifeEJZtxjgXnx8I495Wk7D XnFQ4hUtHJGb3W7d1j+SVg1zH/adeF7hbJ/psziKrGZheABkbZSPi7hD/hnwKg== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:28 +0200 Subject: [PATCH 01/11] dev-manual/wic.rst: replace deprecated wks directories MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-1-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=3361; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=tHQQtJdhH2De3dvzAM9CR0vGK+K+ldSfTB8QVIc5wlo=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX0sEvRkvoCPIMgVSyQpz6Z7VRB4/ZhMkXt6 bnyaLDQ1BCJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19AAKCRDRgEFAKaOo NoQHD/9SYt+8OcUp9T6mz2PTtHSLwv+/OiuVYtmPJnliVAcAw4y5CQRjvqY81BejbOmC8K9w+eb sK90z2SlBZ+jeV73AmL67lWzBRPB4Mf6qtvHS56SB9kY+4VNLnbEQ/dEUFjOf8Mpw0FZ+2kkbFA EMwOj/TyH/gsfh4RQnC2HYBE4QFXb6moINOwWFgySdT0c7nzJHwoNWzq1ne+rADA4ka6HQmfaf8 YoH0zdaVGmG1sK2P04rwLNLVg5TBuNKPTqN6hv3SxlpMkvgk6AVG3gC7baIsDsjETWdos53TCBA /Wl80PG0p6ILOAumPFO5h8h/27+UVSBV21W3KKWL6UScIcD8RcpeNvrZVN7lOoc0BzuL8drK1dL NVuMazPiFUOMV8oCDNGp1reZdQxZKjarKBQ+DyxDcnkW+JV7AijLbUhJh3QHqDHOZ25orRAJ5qy daRifXwkmMSVukaYspwauXWf0HdWWSdHfOqJMK/GZm9cieM576MoxHfn+BEk0yO5wdVQAxOy9tY AsUx07QEOS+o4570cNiTJHTUFboNKxhVbL6KqtlK4AIsWXlEyT2pYuJtqaqNWniKDVRKlF7BbEv ncGQNe6a7uVhZSe7JwedoRA6EcorvzpEIkQNaeRcfLvsDQ/4gSn02dLbi7iDOdOVhdR6hsnmmcU sM48RetD8YABxJg== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9884 Since Yocto 6.0, wks and wks.in files must be placed under files/wic/ inside a layer. Update the examples to use this path. Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index 60b08f834..ffe1d878c 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -276,8 +276,8 @@ existing file provided by the Wic installation. As shipped, kickstart files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the following two locations:: - meta-yocto/meta-yocto-bsp/wic - openembedded-core/scripts/lib/wic/canned-wks + meta-yocto/meta-yocto-bsp/files/wic + openembedded-core/files/wic Use the following command to list the available kickstart files:: @@ -482,7 +482,7 @@ file:: NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native INFO: The image(s) were created using OE kickstart file: - /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/mkefidisk.wks + /home/stephano/yocto/openembedded-core/files/wic/mkefidisk.wks The previous example shows the easiest way to create an image by running in cooked mode and supplying a kickstart file and the "-e" option to @@ -527,7 +527,7 @@ This next example demonstrates that through modification of the As mentioned earlier, you can use the command ``wic list images`` to show the list of existing kickstart files. The directory in which the ``directdisk-gpt.wks`` file resides is -``scripts/lib/image/canned-wks/``, which is located in +``files/wic``, which is located in :term:`OpenEmbedded-Core (OE-Core)`. Because available files reside in this directory, you can create and add your own custom files to the directory. Subsequent use of the @@ -542,8 +542,8 @@ The example begins by making a copy of the ``directdisk-gpt.wks`` file in the ``scripts/lib/image/canned-wks`` directory and then by changing the lines that specify the target disk from which to boot:: - $ cp /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/directdisk-gpt.wks \ - /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks + $ cp /home/stephano/yocto/openembedded-core/files/wic/directdisk-gpt.wks \ + /home/stephano/yocto/openembedded-core/files/wic/directdisksdb-gpt.wks Next, the example modifies the ``directdisksdb-gpt.wks`` file and changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The @@ -580,7 +580,7 @@ Computing (nuc) :term:`MACHINE` the NATIVE_SYSROOT: /home/stephano/yocto/build/tmp-glibc/work/i586-oe-linux/wic-tools/1.0-r0/recipe-sysroot-native INFO: The image(s) were created using OE kickstart file: - /home/stephano/yocto/openembedded-core/scripts/lib/wic/canned-wks/directdisksdb-gpt.wks + /home/stephano/yocto/openembedded-core/files/wic/directdisksdb-gpt.wks Continuing with the example, you can now directly ``dd`` the image to a USB stick, or whatever media for which you built your image, and boot From patchwork Thu Jun 25 09:33:29 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90969 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7AAD5CDE006 for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7574.1782380026862136789 for ; Thu, 25 Jun 2026 02:33:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=I3YYtm4n; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 3368C4E408D2 for ; Thu, 25 Jun 2026 09:33:45 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 0A0B55FF03 for ; Thu, 25 Jun 2026 09:33:45 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 377BE106F07AA; Thu, 25 Jun 2026 11:33:44 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380024; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=z28uj0hW8y78401kLPdFwuwPNsZATbDkC78y0yiY+bw=; b=I3YYtm4nkdXL02Huo9HxaXIMR96hwBqRv1W0hZ4urKHRWwQIhCbqn9c2SEzv5YLo0XMO2o lfONIdoZuKI4z2QLHu67LnZZA919Z/HmNc3maT3CWYXl+Nx6aHHgkktW/91yH4cozXhkhW c/DXrV81d5fp9tdruBSW7u/9xSKbTzJaCTemzOgZsv7IfkkBzMvq7lC+upTZvSIbalIf// n4RZgpiTl6Xoe4axVsrbiqAn5NSgduxkwaJaeNjRllgg2AfnpHYXr+bYeU4xA+/wj0VaxM LKzb0lIFLl+ccS94q4BbV+UB0y+UX3D+tCibT0mKDRxd+TXaPUVCjjpgRzig2w== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:29 +0200 Subject: [PATCH 02/11] ref-manual/classes.rst: replace deprecated wks directory MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-2-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1278; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=Ox4Of5nFOXB6P7R5F26dHgjCYVKMlU+haaROXV1nTpU=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX0guO79psDHkWf5iZE2jN3M4phlRmUsv2Q1 IuF2iWZBXGJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19AAKCRDRgEFAKaOo Nk6PD/0ekH6zHxNmg8cxzYh3pIiJZZVqXiLdXrlMhZ8vehoFyunBFnm0sL408y917/1Jh5Jcfxs bEQEwVa/ubT2iGlkYdxdjRMwYWQQGE353HBy9bgPmiOO7ZNj5MdaWcyGkUP7CjSfy4DCwrIgD+m 2W1BNdFcvgvH1ndPpIsP2YMfw/chL3I8pOGHbDHyhFOknKc3RC3f9aSQy3welHqc9/cGQjl+d6k Le4nxGF0aWy4+mY8gciy9F9qG5AG8Amny3CE4h9adDiaaL/9H6aoXjkti9dYTY8RLOy7RbAj2ZV B9DoXiqnOn0cUJLeUKzGLzBTn6rEXDH4gBO4R9K/aZj2L+RcRq0Pf46AsZRtMaKEIDtc/28qDsT HRe+rsaUT06nV0bGk4NV2yfeOyH1zBAk8itNg8Olv+JdDl2i1pvaU6Oa6gvYgsqnvARYnJ48p1e l71QEjxoMuUlh+8zn1/BpwKOazvMoZ2hXrqLJOLAKHO2sc4IPBlZQPsTtA2a+Bdzh009mVDWnVc 3MOJghhRmOW16OHN7c/hZfWDXVEvWbMKyzA1l4DuIxF4F3pqzqZ2cGutfomuf0+XZ0Z9P6j+gMj yO0pej53Ah1nH7j0hNVfyVASzhZZPHHTQ+1u2UidWf+l5tjboP0ocbkW/WZjcSIgQi9UwcPdV7Q ZdhW49pJHLr5lBg== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9886 Since Yocto 6.0, wks and wks.in files must be placed under files/wic/ inside a layer. Update the link to the efi-uki-bootdisk.wks.in file. Signed-off-by: Antonin Godard --- documentation/ref-manual/classes.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 56a8e7e98..b69e10e74 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -3534,8 +3534,7 @@ by rootfs image recipes. The build configuration should also use an on target hardware. Using ``systemd`` as init is recommended. Image builds should create an ESP partition for UEFI firmware and copy ``systemd-boot`` and UKI files there. Sample configuration for Wic images is provided in -:oe_git:`scripts/lib/wic/canned-wks/efi-uki-bootdisk.wks.in -`. +:oecore_path:`meta/files/wic/efi-uki-bootdisk.wks.in` UKIs are generated using ``systemd`` reference implementation `ukify `__. This class uses a number of variables but tries to find sensible defaults for From patchwork Thu Jun 25 09:33:30 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90978 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id C1C3FCDE00D for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7575.1782380027589549436 for ; Thu, 25 Jun 2026 02:33:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=IaTUwhxj; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id E3E054E408D8 for ; Thu, 25 Jun 2026 09:33:45 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id B9E585FF03 for ; Thu, 25 Jun 2026 09:33:45 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id ED7FA106F07AB; Thu, 25 Jun 2026 11:33:44 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380025; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=5OELTGJcSp+17kFys1Uh98c9yvB0O0T1y2lySgHj3NA=; b=IaTUwhxjtffDYo5mCZYbcrkkIsvgKxBBNVImGo6VC2R9C42V8lMuczGCceWqCjzDQ08Fat 0qjphwBviDdJJXDkt1swipi1fHYuTbMuySL8++JnHBNR2XVb0eYh2EzqVQn3/1RRIgLz7O TQtnDp6VeqxsH7vMRykqFHKtG1qDblX1HeK57plSK1d48WG7B/kevMWs+BceNpGUADH7KG Z+15lP4EssbIv7Ca4EfuqJo+VC7r/35K8GcDFMQZOlEJ9WVLcDNIRv498V7Zl2EZJs5qsM RjsVbVHSw90DsvPwrSuiKrxJvgBQA1Vrm2gxlp6bCfUC6eHZBPKGoVoA7d9scg== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:30 +0200 Subject: [PATCH 03/11] ref-manual/kickstart.rst: replace deprecated wks directory MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-3-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=973; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=wizrrXOCugufjWLYBklNlPPAXyxNW9Uo7Zzt9tuDOKI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX0Xw+OwTZZpG6jWN5qv2h+zOBjH5yjejd5N I8Y4I38cHiJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19AAKCRDRgEFAKaOo NlK6D/9AMNesOuQZzeLHdsjSrt5lMeUzyylzXbRZd90fnrMXibcKufFNv8gNu0tj7D3zJgKmFvs CEkAYAbkwegmeciKhQaa4sVIK/ktTDkRjEndv0aVAEDyl1O02BLLnaRlyg554bWYNXFDYLS6dWG BAl0mOSFUDCwS8mCnEjxd3kYpOVLXhlYJWBmL+IoDBNFSsA7VN/sr8bgaw0Mo7KyEqmmZ6AjX/v cfWeX1fTvmuEbHka4WVST8dGj2Hm8/tcWh5ZPcir3QZPkk1Tkv42a8JUpeFpUwM/A+o9zQFO8DE a4QXJwLANkpNt8Y0h7Ty9GxcMDhF2CCgHhX5F9yloFgRFf9BtVJT+DX19sEwG2luVvdgwgaY/11 0q5J+ASSdnXM5/7UQpe4ZjXBWaIGCk72gxImXtSnPsALKgxhuoW6Pw29kDC1bCEmEb8s2dyn/n5 lyTQ3BiLnz0BEjFRVVhotrYWvbmKVr0r87/K61RMJylcDrdSd62m75dYDM6GR2p0f6xsJPtcuBB KXfjhuX6nus6Tn6BTKk4H4x5Vx7t+5lu54YtVQ7r/fYugL/aofgwGe0wNtZQw0hzu4V1Hrk8qj8 4WUlI+WXFk/eiNjPSKcKWe31+U/vWtKY6+zKDCouu5iUA2Y6pRiPhID0sL58X8BLIXgHPzl0BEo OvdBt5kvKCrmJzg== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9885 Since Yocto 6.0, wks and wks.in files must be placed under files/wic/ inside a layer. Replace the "canned-wks" mention. Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 80e2f9d84..9ab806899 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -230,7 +230,7 @@ supports the following options: - ``--configfile``: Specifies a user-defined configuration file for the bootloader. You can provide a full pathname for the file or a - file located in the ``canned-wks`` folder. This option overrides + file located in the ``files/wic`` folder. This option overrides all other bootloader options. - ``--ptable``: Specifies the partition table format. Valid values are: From patchwork Thu Jun 25 09:33:31 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90973 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id A37CBCDE00B for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7576.1782380028323462897 for ; Thu, 25 Jun 2026 02:33:48 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=tetzxzvq; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 9DAC74E408D9 for ; Thu, 25 Jun 2026 09:33:46 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 6CA6C5FF03 for ; Thu, 25 Jun 2026 09:33:46 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A0141106F07AD; Thu, 25 Jun 2026 11:33:45 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380026; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=k7r+nDBzCiVPW0fic3g+PxGl7G4EWm+UY7Wtpitlras=; b=tetzxzvqdIkkybSh2a1kkrByESYMQzWXUhpE8gaZiA7Tn+fAswsXXL51i1721mlv/4KCjl DKS2AK12m/dJxBeE3h8dLxEkeNaEsSgVo1KTyv4FFac1BhboBKu73r+OvhqQe4Ky/lnFPZ M0D6CaYIiBLXof9Sz6TCwAMEDv+uUcjEpES+IPeZoskIsqZOCecKN7pssZ2qFH5u6oCJbc 386rYElEn0NY2NfcyYMVD9Kb/Ekhf/ekko8pMdzh6/zQKprCRPwETM1Y6Ufr35qBcZKnry Q/2u7dCVyt1+AmOQqNdDa97UdaLWtFK5kGNWHtb5214OVGf1UN2cWBS4TAmicA== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:31 +0200 Subject: [PATCH 04/11] bsp-guide/bsp.rst: fix raspberry layer content example MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-4-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=901; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=4O2gJHJ5hOP2bhjmK93oQI4t7HgbH518gUfWQRnv99Y=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX0xwyGM7UZASYCZYz9K+LH+pv7l+Qcu670c Y26RabpmZOJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19AAKCRDRgEFAKaOo NihRD/0WRix+y3ArfNLXE8z1BlNcofPRLee8o5vbigJPh69tbwdOFiCFwmepQBfqtGoKgnoSp7G Z8C1JirNxo/H+SnBA+io8JJpQ8LHVbCunCIGVWVVVxMAcpm1LoizxarStpB/zZT8nnqajXc+142 EZfI/SFAQZlAH/ijb2qXoVhrzk/Twyctw7v8RVIqXA+OYSIsYPoezv/6y5CIdNr/xfePcAmfhXi 3su236I2mda/S/aYpde8wBpnLs1LX5QR3wHuQCQd22WmiU9gsCy+WxzZECfdLvHhxiz/vtU09ij YCOCz2Pnick0HlL2fagzo2qJZl9FDwBFQwCMo49eTQygKm8mMVfJufquuvkN9tD67q/5ubhL19D 5hEXaY6nIrP0DqBTg8383bizGzjpspiTZT89GdKXTmqneaiUviPQNnRNZuFScYM0C8CaYzN+RoF Djg9NNmqVrunmBx0+CSXreNjYCi91WmAYGdbtMdKR3qWPUEJV7R4nQ25jYcPjYZ3vM/F+4K8bgC kj3Z1GllQJVMMKW9BLVl8jAzqs1zEBvsMFzIwR0WF7YKUljIjXAx9+f/b1xuhoB9+GKyOT2GOwI krgqkDOH/BOZp4cQFrCKwdUOt0bSbOv2jxlqRWJBsEsaqDwLboG+3wQji1xIpBI9CWOY8AW73f/ 3Nc4fxvkpmPoSiA== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9887 The last two items were on a single line, but should be two lines. Signed-off-by: Antonin Godard --- documentation/bsp-guide/bsp.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 4ced9665d..9cf0642d7 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -440,7 +440,8 @@ the :yocto_git:`Source Repositories <>`: meta-raspberrypi/recipes-multimedia/omxplayer/omxplayer_git.bb meta-raspberrypi/recipes-multimedia/x264 meta-raspberrypi/recipes-multimedia/x264/x264_git.bbappend - meta-raspberrypi/wic meta-raspberrypi/wic/sdimage-raspberrypi.wks + meta-raspberrypi/wic + meta-raspberrypi/wic/sdimage-raspberrypi.wks The following sections describe each part of the proposed BSP format. From patchwork Thu Jun 25 09:33:32 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90976 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id EFE84CDE00E for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7577.1782380028875167262 for ; Thu, 25 Jun 2026 02:33:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=oYwC/aWG; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 2D7844E408DB for ; Thu, 25 Jun 2026 09:33:47 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 034765FF03 for ; Thu, 25 Jun 2026 09:33:47 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 4EB01106F00C6; Thu, 25 Jun 2026 11:33:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380026; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=BrKKF58jdUfZPoYILSRKi9XYbcZWek2F4xxdJMNIYxY=; b=oYwC/aWG3FBwd7+u7d9GECL4tvBBJ5Ul5BdrKFJe4aqAwDJsxk8DrCBPkMT8Wuzd+OUdOh pG+on3pDbVT676Pru9+1fc8Oalj1nWfFdFKebYRnmhTvda27ipKpzB7JqxLoTctCJ6DqWr xPcSXrCnt58WP7+0apHeJbKpGcIfWiLpd4Kitg37lXbSfuQNT1z/zC6CT+/1O0t/7+3T5l um6E6hC6Um1DWxgMIpl/AxtMtcTuLyQ7gSBxpEX+o7HDoNBMqUUXLkTmyMoMBkCJTKuVtI hYN+SPB3RUPo/SPJtQyMj7kD4O1st850+rkr2pSjBJcCZNjbUmgmd6mUKXD6ow== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:32 +0200 Subject: [PATCH 05/11] dev-manual/wic.rst: remove note on wic-tools MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-5-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=864; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=zd28XogreKBGv76R+8zLCT23ZSpT/99p3j7jqmk2SdQ=; b=kA0DAAoB0YBBQCmjqDYByyZiAGo89fWhkeAHODjLflIkro5h5N0vMRZgUUV0C20TliuLpmSgs okCMwQAAQoAHRYhBIZIclGI3UAbuaDT/9GAQUApo6g2BQJqPPX1AAoJENGAQUApo6g2ANQQAK9K tV5Hc+rmjcVY9p6jWvrjx8IrwlF3l+LhXiMfXEmVDpcaSzO64UtpXfzUU1LkonXRmAoqrHigs8G MXqStdBylL10ZHUrJ3w/9TfM+0t25cKPgT4GPhDUozUM+0A1zMePaalLDpjXCLkBV1LC+imTNwN WBOLVhLpbNfB1rPrqhMv1XfWkdneefPrc8eKEVkUdVmJSKSB0J5RU+RVetwvuyT3oDSnNG5XpS1 opgsG4Ot9WtVbqhxGhHjwYbrSny3/07EpJARMhm24qOQkaBEzo3T2pNMUtjUKdmbjjlG5XEn8sR gcnC5/YPiSjPMIWGPJk0sNytQRiZwpnHwhP/1qFr/CLW7G1VVm50PyPG9oluE7UhDCMQn2lI0L2 nqGRBMfLm1wijxSD4Piqg1gvT+KNpmFbyT1femXvBLg5arS8Y6b62PtJ2RwL58badPhoNtAjlSx dAa1KuMedD1Nav7sn2+b43XhLwE4pncebsl66RMaY188u2UcUW+oCXc3SjAPlNYGPM2I14Djych 8xh0aY6eVsCgvl0Wec2yXyZ/+YNhD9/liq7gUIAMrrnLVh2gW3BW+W1WihvqEe/2iaEkELC2JsC XYq4wUFh6UPrSJflZwXf7p/rW2/Jm3sG+Y8tgpwHvSJ7p8iHesiPxUiJZyovTT72i9Q9DZ3HnCW QhxcV 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9888 Building this recipe is not required to run the `wic` command-line tool, so remove this bullet point. Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index ffe1d878c..c74f898b6 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -89,11 +89,6 @@ system needs to meet the following requirements: using Wic, the current version of Wic requires the artifacts in the form generated by the OpenEmbedded build system. -- You must build several native tools, which are built to run on the - build system:: - - $ bitbake wic-tools - - Include "wic" as part of the :term:`IMAGE_FSTYPES` variable. From patchwork Thu Jun 25 09:33:33 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90968 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 45F0BCDE002 for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7578.1782380029376161909 for ; Thu, 25 Jun 2026 02:33:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=lOiPSKVL; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id AF15B4E408CA for ; Thu, 25 Jun 2026 09:33:47 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 860745FF03 for ; Thu, 25 Jun 2026 09:33:47 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id CA333106F07A9; Thu, 25 Jun 2026 11:33:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380027; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=i0IAOSCt6FvMQccjNhduY7MmxXq91mVKxc2jgjyGYtc=; b=lOiPSKVLxCU3klGf3V92oGb5L0Eh++xtnQL2FZfd4kdH5cqF27lPpFlf/oWpA7rpgnbuza FC5RnuOiWoIPUApUHluyuGQnQOrYkzoWHxZRa/BVLSuJZDJi78jPySJ4GbJh6TNP8EtpWR MjMfHVsY7p4Ym4i84xHNOnWRC3bMSNPAUR+kiTO5kF+7wdW4YCxj3kjVc2TpYCGH3GwV/R Zab3NfsCwPg2q5RsI2auN/dPwQ+6WD5qGpayY2KZFVK7x+2jZf+UcX77/uQOHgQOVikopw FsqnOvc8VfcDyZLNyXxmO3axhnGKjPm3ggHABnPv6fBIlKbRvRMX7AQq/FqIOw== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:33 +0200 Subject: [PATCH 06/11] dev-manual/wic.rst: remove bullet point on host requirements MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-6-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1684; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=W446PYSDclS7pRl8zPZhWcoH9qVddFZtuKtHaPfEA7E=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX19Gt95IxlHkcGs1DMzI2S7eD7kpCN+AHRa ImRoefbp52JAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19QAKCRDRgEFAKaOo NhFwD/sHR+ua0d58vzS+atPWtdTk1l1PgRFomfS6oko25U2JIxR2I4uMYuaX2T8XA/MDUtpERTO C1mNYVBZaKzzh67X2Bdi3QXtCLTuUSNU7PTlpxr6U4G7sT6zhshHfKTwjRvq0eso+PnaVbcz1Dg eBhT6sE4CBTGOgxESSmZU3JjVIZ9gMUNzNFMYRnXsmvcXv3eUpBAE4fX2iOkLWeNcdRNRoTCTfo A2Pg8a2lIa/srgS64izrN6r+iEx0hWT/9ouZSVqTNgngIYACcDhReJ3lLATulnI7c51MTd5u69q R+nJRkOfB7uYLiNmElQXBCwcgUXrco7rCjiSgHnnoM7IjfzQhDrpjFpH1MRKWtX0a/3cc26fX3S 8pLCWf0U1oeHhwFZoKiD7BCXgxB0pyYni8T8q6oG+CkG4B6kqxH6V8voEYlc6kVpVp/B098WDsk mhUPseTvtTAgKlbmXfXEyBxSoSjqTj1S5UbbaTDlBiTUsOa6Z0LtXulScVaOW/nuwynWclqOnrt w85pnzZ1hhfHLtvZ1H+kiwqTEaf+1id4EhZn3OcEOHql7ynGdzqBnXWH/MejcrDr/MTR+HIx32D JYHy4AIWtQLlDIVOtxeAqSEywPGgUZcchDuEQudZbJbQ4Ca5qCSiFmn4Gu2bD/0OsZTX4ZyPSOk 5bhbfJp7A38ihIg== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9889 Using wic requires the build directory to be created, which implies a host that meets the usual requirements. Most of our manuals are based on this hypothesis, so no need to add this note here. Instead, simply mention that the environment should be ready for use. Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index c74f898b6..ef8c530c2 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -71,16 +71,9 @@ Requirements In order to use the Wic utility with the OpenEmbedded Build system, your system needs to meet the following requirements: -- The Linux distribution on your development host must support the - Yocto Project. See the ":ref:`system-requirements-supported-distros`" - section in the Yocto Project Reference Manual for the list of - distributions that support the Yocto Project. - -- The standard system utilities, such as ``cp``, must be installed on - your development host system. - -- You must have sourced the build environment setup script (i.e. - :ref:`structure-core-script`) found in the :term:`Build Directory`. +- You environment and :term:`Build Directory` must be ready, as if you were + going to run ``bitbake`` commands. See :ref:`dev-manual/start:Initializing + the Build Environment` for more details. - You need to have the build artifacts already available, which typically means that you must have already created an image using the From patchwork Thu Jun 25 09:33:34 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90972 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 839D5CDE008 for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.7330.1782380030091816511 for ; Thu, 25 Jun 2026 02:33:50 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=xh/Uy8hH; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 692E64E408D1 for ; Thu, 25 Jun 2026 09:33:48 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 370385FF03 for ; Thu, 25 Jun 2026 09:33:48 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 6F04B106F07AE; Thu, 25 Jun 2026 11:33:47 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380027; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=exgBweiUpsgBp5RgoJXihvZc8VIWukNBijCbeTuH3s8=; b=xh/Uy8hHVA9siDRcbhxXxcqrZOYCxl2pXJGaUDbKeIrWKNrnE54N+3N1bewYzEyqQdYcIz YbB5znHT5lbDWF4UWsGqakAbBi7NBIVpMMRM90FGu3wubEkFjnELEMEl4qkurf76MkCwj9 y+y5As8aAnaugNhSQgAfGOFaGMrQhjj86AWwlaAFr/0q8LrF6Ozjmp0FRd1qTbeCrchD0N gL6OVzCY6O4rNSPtSy+6lZZSV9xWeRKmNm8Oe5fq+tas7nMLgXEwc+hJowUYFX4w28ag63 BuWVmvXm/IVz/Ou5MWP6X4H5DoNO5urGegz7xShjWIdHTXKLnGbSNQfQKKbvqg== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:34 +0200 Subject: [PATCH 07/11] dev-manual/wic.rst: add where to set IMAGE_FSTYPES/WKS_FILE[S] from MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-7-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1304; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=cwUF8rP6vKfwFhEcPuzBaKvKas56mimWJQ/4vFfH/y0=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX1mtFj6kanZchHBfahrKYfxpWkDGpk3cHOJ LIkXRmZ5kuJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19QAKCRDRgEFAKaOo NndtD/9nCz/10e9XBOjxvN4yrN7mhvmeb8B8bbMZ2e2eU2qnZa9brjVHkYoaFOInUFxrmgpLxGv Jiz77wANRfs5xTrzbg67Wd6E02myQ+7I+d7aOWsLKRYEyDb+TI7BlMnfsORHwaosaNb5u+HUztM XUSZFK2ILDpJ2IAc2GeSR4jf58NKMvW+iH2m5e9rZFx0LjX1r3erfxc0kF6nG9fJ2t3kFl1HY8Y cPxDSHGLgOp9v98FmM+NiHi5XY+yFIEp9BX96I5KcIhNtTIDNSCAygr0ymAGAV5JPJ9or60ZGXt ZP5qH8myEhcE6WrVFAzpPgFrV/SpAKg9zLDELW91qrcPWuYe3JGklcB9xNv9dg431VgXskwC6Kb M6Kq1dWYObdK42QE4AJz7i2ZRsthKR3DLFNokH3A9bed3/2kzfm0eImVvy9nLa6i7FQD58cMSR4 ioTgI4YfP4+GpF86ssqbdoW0AHIlrW/fz16cn9VVkhNqNd9KYOIYneBv9i2d2/s0LZsgnr2HkV4 LTC2uAOVIvOWaeWtJR2h+swA3L7gKmu7VfXZaxYYIwSdihGtEQusja0ZU8JBi4plNEsVRBWQ2nU Fyaq7VJY83pOnppqsqj3a3FWcRoMVbvZtCfrvirEcgRESd9Vftg2bZKNLfC8GIrphqlTYAJyJRv am3XGoY60fv14vA== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9890 This is typically done from a machine configuration file or in the image recipe, mention it here. Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index ef8c530c2..5fc7759f8 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -82,15 +82,16 @@ system needs to meet the following requirements: using Wic, the current version of Wic requires the artifacts in the form generated by the OpenEmbedded build system. -- Include "wic" as part of the - :term:`IMAGE_FSTYPES` - variable. +- Include "wic" as part of the :term:`IMAGE_FSTYPES` variable (from a + :term:`configuration file` or in the image recipe). - Include the name of the :ref:`wic kickstart file ` as part of the :term:`WKS_FILE` variable. If multiple candidate files can be provided by different layers, specify all the possible names through the :term:`WKS_FILES` variable instead. + These assignments are typically made in a machine :term:`configuration file`. + Getting Help ============ From patchwork Thu Jun 25 09:33:35 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90971 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4BF1ACDE007 for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7579.1782380030627707187 for ; Thu, 25 Jun 2026 02:33:50 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=RY9F2ozD; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id EBDB54E408D2 for ; Thu, 25 Jun 2026 09:33:48 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id C2A9E5FF03 for ; Thu, 25 Jun 2026 09:33:48 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 17137106F07AB; Thu, 25 Jun 2026 11:33:48 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380028; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=trQgZ1SyL6OKhyWJIrqSq0e8z7SfEQp/adz7SJORYpI=; b=RY9F2ozDeR9i2j4F9GRB6hwwPey3x5beZpkBPV+WT2Uxssk5uKA6wrpii9O+LNe9FftG2l EVoCaJgzhyM3vH/g2C9vdDNpkPZjCSHLaJQpVkl3OjsGUScplrP0TqkMUC+XQg5aoCDcdA 5c6Nwl3IYBkeTQCcvoC9apHyaRzPgzMnB6zXrGO89hesUMABaI3IIjyqEkfR6jT9Glalbo TNIGV6VuVfwj5p4fF0nHHaotyKGsxu4+DruACd5xj8rfCw8wEu0TBcVJQ3+46tRyo/cR++ qgtvAFSDTyh3f8JFQHJd2lAgv2TJCT/VUeXP+g/yWAQirkJLIJTEPndq8WWPNQ== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:35 +0200 Subject: [PATCH 08/11] dev-manual/wic.rst: add a requirement to use wic from the build system MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-8-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1767; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=4dYePi6a/D5t8NFFm/7MxFbMm7PFSl6BP8wSMM14P/A=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX1NKxo8Eylhe/NOfLwDRPYEiGCK/v3qj7Ol GavuslKYFSJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19QAKCRDRgEFAKaOo NkXGD/9YnGa1YtwJ5Sll528RIFA4wB0YjVCxUIu8jxrj5BkQ+CXQqhj060xyCCDw3PoMRU6oh2n y2DIA3tIRF6uWuwAF70Tv5OLM0rXjgciHQygNk6AI396jA1TCzMNw04axrCbAclEb3daUKTzzBJ JbO9mDlvyPGOn9O4IyEPwBuYBwAEbhIFvAX/SH/rqrXGNAPpsrfoBaOZVKMHZbUBnjCUGeAo9VH i2YZHXWwZxXY7bfPrW8LO+VtXXVILmyLCgpSKwuIidtMDHEx2LAgsefPD5d+/zDdBeE1zoPwL9j 1rUogJIknHosjGB5JMg0nLe9uAiw9UuHcCOKQWQ1nqZl6emYcsnxJ7UI7OBY6p+XLT4bbNhUDA7 +lruZdFzuw7jY0p5MGDq6Ma71IwoYaloj/ZAYfOHOJeU+Bg02P39CUIy0+S4OnSchARczA9ofiB siIA0FVnrFYrPzBgau4oJ1OkB2tJhYxYyU8/cLF3iAWMqwPq2U9qJyi8nKu1DGWwLi6yyTlV0Jj nqBz+3TSELghLf18L1iBCoxL3H5hVt78rePSyJf2kAnvUirTy6DL43jfbv6QHXSTd0M0pChgTLa W6NibBqdDR0OfZzdrp+iHHhRbWkhWF2kholMXgMuLW3UdXi1jdOUoOuD2Fz14MgW60QIiTfmtzP ZFb9GrINiwzsldw== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9891 Since wic is no longer part of OE-Core since [1], we have to use wic from the build system instead, which can be done by following few steps, finally creating an alias, so that the commands from this document remain valid. [1]: https://git.openembedded.org/openembedded-core/commit/?id=25ca1cb46dd6d0c57f61f2dc3b649601dc81b50c Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index 5fc7759f8..980f5197c 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -75,6 +75,29 @@ system needs to meet the following requirements: going to run ``bitbake`` commands. See :ref:`dev-manual/start:Initializing the Build Environment` for more details. +- Make the ``wic`` command-line tool available in your shell: + + #. Run the following command first: + + .. code-block:: console + + $ bitbake wic-native -c addto_recipe_sysroot + + #. Check if you can use the ``wic`` utility using ``oe-run-native``: + + .. code-block:: console + + $ oe-run-native wic-native wic --help + + #. Define a local alias for the above command: + + .. code-block:: console + + $ alias wic="oe-run-native wic-native wic" + + This will make it possible to use ``wic`` from the :term:`OpenEmbedded + Build System` transparently below. + - You need to have the build artifacts already available, which typically means that you must have already created an image using the OpenEmbedded build system (e.g. ``core-image-minimal``). While it From patchwork Thu Jun 25 09:33:36 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90975 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id B0282CDE00A for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc01-g2.7331.1782380031592124799 for ; Thu, 25 Jun 2026 02:33:52 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=WQUbDjkr; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id D62E94E408CA for ; Thu, 25 Jun 2026 09:33:49 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id A45965FF03 for ; Thu, 25 Jun 2026 09:33:49 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A89F9106F07AA; Thu, 25 Jun 2026 11:33:48 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380029; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=y2S77T/leUxN4wHIIz1tC8JZPafQcjobgENc6EWhFD4=; b=WQUbDjkrOM+CwZ6UsyM977eGN9rOiT/7IPm5t50Czb1CwS1Hr5hh69xY8X//QXpDfRfuem f2Aj+fhEILbTOnkfQxQhm5P+/7N0zhSCApSDRvLGq1/Wmaxj+XBgg/KwM+B7yS3wdqQmC1 4VlZrDCyp/M+i9oojuEpOToSM4l3XohyyGXaPTDbSwdYQhkHrmEwAjjkIzi5SXTlxhj9bQ AE4ynGDt9CqZ4PVrZxH/a5/zb3mDVWityFNeCJ4tg4ICRxFIKg0eQErZhut0YlmW8c9dxb fL8O/iqPG+ez7RBM2Z9eyKlftG2uk7MeqBjFOVAkLhSV1JRzHlQuJrZ9zv9wQA== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:36 +0200 Subject: [PATCH 09/11] dev-manual/wic.rst: convert code snippet to code-blocks MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-9-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=13447; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=EULfc3Kbj6mE5RQEEGTSh1UtDqOdMrWFnlYEp5QKxiM=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX11qONONGNXgNLzRalAE6phZwTCVwdkW9WP eQEodtgEgaJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19QAKCRDRgEFAKaOo NuIRD/9hiDlql/8O5+HqhEEAADG+p8PXLPW3VORd/iO5cF10Qu4aW9sS9Nt+ef+7bv9T+7OJk1c 0jC27doTMbRJXaxtfyM7cyjLcIiWH/S1kzae2ZRWxkZ1WK/NiSh+HY+Q3OBswayHEvzZ0y1bBzC JIRuCW2TYlpQA74FsFN/t/Ywq8FqDxR0k08oNoPosoLVNp48taGUiF/II56ZAFMwJ/njRR412mi WOHEZbTwa58aynoP0jSccKiM4Aaylmpqu6cuo6YcQp6dlnxckSBEdNz5yGVmL+1MQeAi9DB+Awl ezjydTYcqKKwKde8BUbwuC56CYnSfLjNf941oqReUoT2ADMEUJ1Nrbz4Sd049wsyFAY5LJ4wiVq kgjoVQ4EoDQDN5jdg2xluTBn/8KIIf9IFvdaPyBWSUy7UuwPP1pQeA5vy0KyT5oQcM/avj8A3zw sCp1CSAwkQTYBg5zg3BLLVQxm02qRoG+NoRO4HcwrDiwu4NYUftt8yRIeuyEqcaw0AaW+mg9wNj KtWuGVWeC+Fy8tSQsxtgwlb4B9WiqtIy870KljkPhygrA0EtRrG9kAFiZG61vi6g02BOrjAxJ1K BfXqX7Mwp2qWUQ3l2F42TthObJak4biOwy8KrNB8cJ238++fJtkXW+nFQm+o71vpgAVfVUDXxN6 Ry9yWf0z09GPBSA== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9892 Convert to current code snippets to use code-block to have proper syntax highlighting, and fix indentation in a few places. Signed-off-by: Antonin Godard --- documentation/dev-manual/wic.rst | 155 ++++++++++++++++++++++++++------------- 1 file changed, 106 insertions(+), 49 deletions(-) diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index 980f5197c..bd3b5f697 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst @@ -120,7 +120,9 @@ Getting Help You can get general help for the ``wic`` command by entering the ``wic`` command by itself or by entering the command with a help argument as -follows:: +follows: + +.. code-block:: console $ wic -h $ wic --help @@ -128,27 +130,37 @@ follows:: Currently, Wic supports seven commands: ``cp``, ``create``, ``help``, ``list``, ``ls``, ``rm``, and ``write``. You can get help for all these -commands except "help" by using the following form:: +commands except "help" by using the following form: + +.. code-block:: console $ wic help command For example, the following command returns help for the ``write`` -command:: +command: + +.. code-block:: console $ wic help write Wic supports help for three topics: ``overview``, ``plugins``, and -``kickstart``. You can get help for any topic using the following form:: +``kickstart``. You can get help for any topic using the following form: + +.. code-block:: console $ wic help topic -For example, the following returns overview help for Wic:: +For example, the following returns overview help for Wic: + +.. code-block:: console $ wic help overview There is one additional level of help for Wic. You can get help on individual images through the ``list`` command. You can use the ``list`` -command to return the available Wic images as follows:: +command to return the available Wic images as follows: + +.. code-block:: console $ wic list images genericx86 Create an EFI disk image for genericx86* @@ -169,7 +181,9 @@ command to return the available Wic images as follows:: Once you know the list of available Wic images, you can use ``help`` with the command to get help on a particular image. For example, the following command returns help on the -"beaglebone-yocto" image:: +"beaglebone-yocto" image: + +.. code-block:: console $ wic list beaglebone-yocto help @@ -205,7 +219,9 @@ In other words, you can point to arbitrary kernel, root filesystem locations, and so forth. Contrast this behavior with cooked mode where Wic looks in the :term:`Build Directory` (e.g. ``tmp/deploy/images/``\ machine). -The general form of the ``wic`` command in raw mode is:: +The general form of the ``wic`` command in raw mode is: + +.. code-block:: console $ wic create wks_file options ... @@ -263,7 +279,9 @@ a kickstart file and the name of the image from which to use artifacts by using the "-e" option. Wic looks in the :term:`Build Directory` (e.g. ``tmp/deploy/images/``\ machine) for artifacts. -The general form of the ``wic`` command using Cooked Mode is as follows:: +The general form of the ``wic`` command using Cooked Mode is as follows: + +.. code-block:: console $ wic create wks_file -e IMAGE_NAME @@ -286,12 +304,16 @@ Using an Existing Kickstart File If you do not want to create your own kickstart file, you can use an existing file provided by the Wic installation. As shipped, kickstart files can be found in the :ref:`overview-manual/development-environment:yocto project source repositories` in the -following two locations:: +following two locations: + +.. code-block:: text meta-yocto/meta-yocto-bsp/files/wic openembedded-core/files/wic -Use the following command to list the available kickstart files:: +Use the following command to list the available kickstart files: + +.. code-block:: console $ wic list images genericx86 Create an EFI disk image for genericx86* @@ -311,13 +333,17 @@ Use the following command to list the available kickstart files:: When you use an existing file, you do not have to use the ``.wks`` extension. Here is an example in Raw -Mode that uses the ``directdisk`` file:: +Mode that uses the ``directdisk`` file: + +.. code-block:: console $ wic create directdisk -r rootfs_dir -b bootimg_dir \ -k kernel_dir -n native_sysroot Here are the actual partition language commands used in the -``genericx86.wks`` file to generate an image:: +``genericx86.wks`` file to generate an image: + +.. code-block:: shell # short-description: Create an EFI disk image for genericx86* # long-description: Creates a partitioned EFI disk image for genericx86* machines @@ -375,7 +401,9 @@ When the Wic implementation needs to invoke a partition-specific implementation, it looks for the plugin with the same name as the ``--source`` parameter used in the kickstart file given to that partition. For example, if the partition is set up using the following -command in a kickstart file:: +command in a kickstart file: + +.. code-block:: shell part /boot --source bootimg_pcbios --ondisk sda --label boot --active --align 1024 @@ -386,7 +414,9 @@ members of the matching source plugin (i.e. ``bootimg_pcbios``) in the To be more concrete, here is the corresponding plugin definition from the ``bootimg_pcbios.py`` file for the previous command along with an example method called by the Wic implementation when it needs to prepare -a partition using an implementation-specific function:: +a partition using an implementation-specific function: + +.. code-block:: python . . @@ -477,7 +507,9 @@ Generate an Image using an Existing Kickstart File -------------------------------------------------- This example runs in Cooked Mode and uses the ``mkefidisk`` kickstart -file:: +file: + +.. code-block:: console $ wic create mkefidisk -e core-image-minimal INFO: Building wic-tools... @@ -513,11 +545,15 @@ and kickstart file information. Continuing with the example, you can now write the image from the :term:`Build Directory` onto a USB stick, or whatever media for which you built your image, and boot from the media. You can write the image by using -``bmaptool`` or ``dd``:: +``bmaptool`` or ``dd``: + +.. code-block:: console $ oe-run-native bmaptool-native bmaptool copy mkefidisk-201804191017-sda.direct /dev/sdX -or :: +or : + +.. code-block:: console $ sudo dd if=mkefidisk-201804191017-sda.direct of=/dev/sdX @@ -551,8 +587,10 @@ will need to boot from ``sdb`` instead of ``sda``, which is what the ``directdisk-gpt`` kickstart file uses. The example begins by making a copy of the ``directdisk-gpt.wks`` file -in the ``scripts/lib/image/canned-wks`` directory and then by changing -the lines that specify the target disk from which to boot:: +in the ``files/wic`` directory and then by changing +the lines that specify the target disk from which to boot: + +.. code-block:: console $ cp /home/stephano/yocto/openembedded-core/files/wic/directdisk-gpt.wks \ /home/stephano/yocto/openembedded-core/files/wic/directdisksdb-gpt.wks @@ -560,7 +598,9 @@ the lines that specify the target disk from which to boot:: Next, the example modifies the ``directdisksdb-gpt.wks`` file and changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The example changes the following two lines and leaves the remaining lines -untouched:: +untouched: + +.. code-block:: shell part /boot --source bootimg_pcbios --ondisk sdb --label boot --active --align 1024 part / --source rootfs --ondisk sdb --fstype=ext4 --label platform --align 1024 --use-uuid @@ -569,7 +609,9 @@ Once the lines are changed, the example generates the ``directdisksdb-gpt`` image. The command points the process at the ``core-image-minimal`` artifacts for the Next Unit of Computing (nuc) :term:`MACHINE` the -``local.conf``:: +``local.conf``: + +.. code-block:: console $ wic create directdisksdb-gpt -e core-image-minimal INFO: Building wic-tools... @@ -596,7 +638,9 @@ Computing (nuc) :term:`MACHINE` the Continuing with the example, you can now directly ``dd`` the image to a USB stick, or whatever media for which you built your image, and boot -the resulting media:: +the resulting media: + +.. code-block:: console $ sudo dd if=directdisksdb-gpt-201710090938-sdb.direct of=/dev/sdb 140966+0 records in @@ -610,7 +654,9 @@ Using a Modified Kickstart File and Running in Raw Mode This next example manually specifies each build artifact (runs in Raw Mode) and uses a modified kickstart file. The example also uses the ``-o`` option to cause Wic to create the output somewhere other than the -default output directory, which is the current directory:: +default output directory, which is the current directory: + +.. code-block:: console $ wic create test.wks -o /home/stephano/testwic \ --rootfs-dir /home/stephano/yocto/build/tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/rootfs \ @@ -655,7 +701,9 @@ The following example examines the contents of the Wic image, deletes the existing kernel, and then inserts a new kernel: #. *List the Partitions:* Use the ``wic ls`` command to list all the - partitions in the Wic image:: + partitions in the Wic image: + + .. code-block:: console $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic Num Start End Size Fstype @@ -671,33 +719,36 @@ the existing kernel, and then inserts a new kernel: .. note:: You can get command usage on any Wic command using the following - form:: + form: - $ wic help command + .. code-block:: console + + $ wic help command For example, the following command shows you the various ways to - use the - wic ls - command:: + use the ``wic ls`` command: + + .. code-block:: console - $ wic help ls + $ wic help ls + The following command shows what is in partition one: - The following command shows what is in partition one:: + .. code-block:: console - $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1 - Volume in drive : is boot - Volume Serial Number is E894-1809 - Directory for ::/ + $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1 + Volume in drive : is boot + Volume Serial Number is E894-1809 + Directory for ::/ - libcom32 c32 186500 2017-10-09 16:06 - libutil c32 24148 2017-10-09 16:06 - syslinux cfg 220 2017-10-09 16:06 - vesamenu c32 27104 2017-10-09 16:06 - vmlinuz 6904608 2017-10-09 16:06 - 5 files 7 142 580 bytes - 16 582 656 bytes free + libcom32 c32 186500 2017-10-09 16:06 + libutil c32 24148 2017-10-09 16:06 + syslinux cfg 220 2017-10-09 16:06 + vesamenu c32 27104 2017-10-09 16:06 + vmlinuz 6904608 2017-10-09 16:06 + 5 files 7 142 580 bytes + 16 582 656 bytes free The previous output shows five files, with the ``vmlinuz`` being the kernel. @@ -706,15 +757,19 @@ the existing kernel, and then inserts a new kernel: If you see the following error, you need to update or create a ``~/.mtoolsrc`` file and be sure to have the line "mtools_skip_check=1" - in the file. Then, run the Wic command again:: + in the file. Then, run the Wic command again: - ERROR: _exec_cmd: /usr/bin/mdir -i /tmp/wic-parttfokuwra ::/ returned '1' instead of 0 - output: Total number of sectors (47824) not a multiple of sectors per track (32)! - Add mtools_skip_check=1 to your .mtoolsrc file to skip this test + .. code-block:: text + + ERROR: _exec_cmd: /usr/bin/mdir -i /tmp/wic-parttfokuwra ::/ returned '1' instead of 0 + output: Total number of sectors (47824) not a multiple of sectors per track (32)! + Add mtools_skip_check=1 to your .mtoolsrc file to skip this test #. *Remove the Old Kernel:* Use the ``wic rm`` command to remove the - ``vmlinuz`` file (kernel):: + ``vmlinuz`` file (kernel): + + .. code-block:: console $ wic rm tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz @@ -726,7 +781,9 @@ the existing kernel, and then inserts a new kernel: kernel will be in the ``workspace/sources`` area. The following example assumes ``devtool`` was used to build the - kernel:: + kernel: + + .. code-block:: console $ wic cp poky_sdk/tmp/work/qemux86-poky-linux/linux-yocto/4.12.12+git999-r0/linux-yocto-4.12.12+git999/arch/x86/boot/bzImage \ build/tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz From patchwork Thu Jun 25 09:33:37 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 34808CDB47F for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7580.1782380032700009126 for ; Thu, 25 Jun 2026 02:33:53 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=0N3G4r/S; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id 10B904E408D1 for ; Thu, 25 Jun 2026 09:33:51 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id DA21A5FF03 for ; Thu, 25 Jun 2026 09:33:50 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id 6D681106F00C6; Thu, 25 Jun 2026 11:33:49 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380030; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=XRqZFSUh9qWP02327uKTyl2+Eihwlpahx/ekpOMCdz0=; b=0N3G4r/SkFRJDDDr49OQ3tc94S+Qp4QQPFwfO5ZQnFS7QtqMiOeW9Bx5X0jGlzRvpzzCOp 3fvDUoAiO7wHMwSQdYkWW+7qCytTHMzDKJ20fsgR1CD4lNUeGZNM5RCNa4zjEzzcGmKMSU cHLfiYoAoQe3D5az+WEd+g4Cq8f7sVNZTWLrT8revfr2k9bxJlIoycdQjM5slTTSJgOXIw Cd6B8LnjVj50bQ4/EF1vqW15el0YbYQmwr5rHuJKgyoOdwSyi3hY1ilqvMj7ErT56y2JNZ FXRJ8JObObBU39oiF6bp7+tIP9dytbJsaIeZ4px/19KLejwcCIys2kjDe7O4uQ== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:37 +0200 Subject: [PATCH 10/11] ref-manual/kickstart.rst: remove note on available commands MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-10-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1237; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=oWd9M2XN6BsrDqZeQzKmQCAjfWuc8+i6So4Iwr++2lI=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX2ACjWuqZmJoXZPcgmOFrZcc8RHUvV/fR/r UImcY4dCgmJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19gAKCRDRgEFAKaOo NoQXEADL2Pud5TMnxluKiykeqjyi56UqKVeHPZP7uEKpkOYwJmat5UtwTZWE5fjaXm0QqYro/m+ XUgNMKvvmUDJiJyj/7QzjDB4Bn1TeY4PZnH04q1dS4C1Mg3a78fkkowWa+PfpyXiHfLMGyyiihf 1OD2vXTSn1dbhMYmZG3Ll+ZgHjJWg7Z+y7NZh1Qmie/FlV1O7p/uuFU+numivGbr445gAsQjKm+ MLuZL+YZNB61uO9jTmVIgwgDZF40mTXa/dUeB++RLKMSht5y6rS84Wn+b7pkBR/prMC4JH7bKzv hFA+kVwskDilKo2JJuRTmdszxMyHOmXuWgtrKSNTdecHR+J2MhiZGl8VVmq5DOioo8d2EDtwuVT E2N4gQy5Ho3LTRprOf40apShPZQZrqoJq9AKfHhG0BXzY/ch8W7vIle4rnww60CsiW0LG7bzYqw F11Bi6QbZ8T5DgLWi4xfm8deg2lvkXMWpYYvlKGxyxV3FfkdTqKLh6Awpg4B4LABJLFfP/EaGA4 dK8H/9BWi+i+6fKGjqZH7kI0Tvdp3d0AT/n7Ob4ieKdTMg7jPEqrzciCnNwhkHKARJyTOgpN7/A ObFbxszhM/oLoWODWdqnxr+SNDVYx6IfFd7I8ZuwoCRjdqes6Iy44vH1YUqXeqHBRgld3hsh177 bBsbRoO8suUUMxw== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9893 This note makes for a strange introduction to this section. This is a reference manual, so what is documented is also what is supported. Leave the paragraph below as an introduction to this document. Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 9ab806899..692ee2de0 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -9,16 +9,6 @@ OpenEmbedded Kickstart (``.wks``) Reference Introduction ============ -The current Wic implementation supports only the basic kickstart -partitioning commands: ``partition`` (or ``part`` for short) and -``bootloader``. - -.. note:: - - Future updates will implement more commands and options. If you use - anything that is not specifically supported, results can be - unpredictable. - This chapter provides a reference on the available kickstart commands. The information lists the commands, their syntax, and meanings. Kickstart commands are based on the Fedora kickstart versions but with From patchwork Thu Jun 25 09:33:38 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 90974 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id B4255CDE00C for ; Thu, 25 Jun 2026 09:33:56 +0000 (UTC) Received: from smtpout-03.galae.net (smtpout-03.galae.net [185.246.85.4]) by mx.groups.io with SMTP id smtpd.msgproc02-g2.7581.1782380033381518352 for ; Thu, 25 Jun 2026 02:33:53 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=dkim header.b=2qS5anim; spf=pass (domain: bootlin.com, ip: 185.246.85.4, mailfrom: antonin.godard@bootlin.com) Received: from smtpout-01.galae.net (smtpout-01.galae.net [212.83.139.233]) by smtpout-03.galae.net (Postfix) with ESMTPS id B4FE74E408D2 for ; Thu, 25 Jun 2026 09:33:51 +0000 (UTC) Received: from mail.galae.net (mail.galae.net [212.83.136.155]) by smtpout-01.galae.net (Postfix) with ESMTPS id 8439D5FF03 for ; Thu, 25 Jun 2026 09:33:51 +0000 (UTC) Received: from [127.0.0.1] (localhost [127.0.0.1]) by localhost (Mailerdaemon) with ESMTPSA id A6C6E106F07AB; Thu, 25 Jun 2026 11:33:50 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=dkim; t=1782380031; h=from:subject:date:message-id:to:cc:mime-version:content-type: content-transfer-encoding:in-reply-to:references; bh=OTaUs+19iG/1reL4z0HURLHHuCSUjxykzeJmRtMgq5g=; b=2qS5anim6CN8j9xlNArQA4/l5/N5vfFLbvKs7QI2K5yxy8K+eqnYjFdwh3UhF08nxcxQjQ ohh4KK0K3UVil3jEOVpYtDZBd08S4bnysrP43O3cGwpp9+XnkRo5RPyKTvVg0IP4Vqp9c6 3xdVN11pdZUiL1NaHn3a7cKMmUih+Qi6T98CwaV2T2mNOD7+oGXcOiDaQAnYvaL7OvZTMR K4hi0W2fMR9Or5/lk0bcH2Bj6biI7K7j2BotsCkM2p5ImKV39CcUeLVd3z29lzDnzixCBR NmtkO1A10HrdFHKjz9FbNsiBv2dg7qrM7XRItVf63ssQlgT5PpwU+UwLe3qXkA== From: Antonin Godard Date: Thu, 25 Jun 2026 11:33:38 +0200 Subject: [PATCH 11/11] ref-manual/kickstart.rst: document the include directive MIME-Version: 1.0 Message-Id: <20260625-wic-migration-v1-11-fef8d481aecc@bootlin.com> References: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> In-Reply-To: <20260625-wic-migration-v1-0-fef8d481aecc@bootlin.com> To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard X-Mailer: b4 0.15.2 X-Developer-Signature: v=1; a=openpgp-sha256; l=1158; i=antonin.godard@bootlin.com; h=from:subject:message-id; bh=CXtVEHyizpujNEPuT4MXTGWXK0G76rtEHpP980OBYus=; b=owEBbQKS/ZANAwAKAdGAQUApo6g2AcsmYgBqPPX2uSBFaIEaAorYM0qJ/AeC05M/RFGvY3fid ZXoyCf9j7qJAjMEAAEKAB0WIQSGSHJRiN1AG7mg0//RgEFAKaOoNgUCajz19gAKCRDRgEFAKaOo NmHNEAC9qUJSLRCiR8NJarz2qOFsnA71UADOgky/0DABs+BpF9aHWJcVQ+5BYUfglZZUh4eVlOt VTOswCCvQKq8Eu6FlN5N1UfXwyCg7E8oN3tRIUexwQQ0KgaZbQV4Qv9f0WuwYJWSUGN00427tpy qDJquTlZgGCu2nw6nRz988p51UCFdEQamHtM61HXBe2mXT/acxffqb/o26Dnjs1Bfi58ffLTtSX BZKYxus5zwwtLYW2nmMaoBNcWCEx7OG48zUYQXtFdAnRXxeKvne7OrFQfmnszXJ/8ZkNCAlf63Q uvOJC2Y6pYSpnl9yTMXnQGuZ155TRamTnAhcewt00CzBaLdJ3RE9btu84aTfXzTzzsOzZHBQroo CwlN5wIagYQIU3wNzx4ioljBn/qSBtc9E7H7NMq1hOX7GWlQZr36oLsOSAhujFO5aWd/sNvIOht 8n6aba7bKPLJisKsbNAxHnJ88eAeCCbIwZaxKs8jMFh7j9ZsvJYlD3tdyMgCa18KHFx1RELqlcn cx6CQR3nXH61KaCpHj7yz/YG08FqTwyXDjVU3ikotcZeST8XTnTKwemc8G1qa67+A0w+i7tBZBV EHlH8W+LgPFm5QaszSlKCaD5BE7iKvyVTYoyElwbQLRjQllUzV7ymwevEqDb22QJSy7Qx13QgzS 9KQvGSHf4Qj6/CQ== 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 aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 25 Jun 2026 09:33:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/9894 Including WKS files into others can be useful to avoid duplicating code for similar images. Add documentation for it. The example was taken from the meta/files/wic/directdisk-bootloader-config.wks file in OE-Core. Signed-off-by: Antonin Godard --- documentation/ref-manual/kickstart.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 692ee2de0..e7cba555a 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -232,3 +232,15 @@ supports the following options: - ``--timeout``: Specifies the number of seconds before the 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 +the current file. For example: + +.. code-block:: shell + + include common.wks.inc + + bootloader --configfile="directdisk-bootloader-config.cfg"