diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-07-29 11:56:49 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-08-08 23:41:10 +0100 |
commit | 1887b330c3a04723472a43497d58201b27b86f05 (patch) | |
tree | 6a12321dceaff7d9b9910b7de469c41daa4673c1 /documentation | |
parent | 7dc3a0be6f70a3f6549e5bd279cd5521a8f3636b (diff) | |
download | poky-1887b330c3a04723472a43497d58201b27b86f05.tar.gz |
docs-wide: update wic source plugin names
WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source
bootimage/isoimage rename to allow be imported") in OE-Core. They no
longer contain dashes, but underscores.
(From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/wic.rst | 16 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 4 |
4 files changed, 13 insertions, 13 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 7eaa4d8700..a6444d9af1 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -1425,8 +1425,8 @@ Project Reference Manual. | |||
1425 | 1425 | ||
1426 | - :term:`IMAGE_BOOT_FILES`: | 1426 | - :term:`IMAGE_BOOT_FILES`: |
1427 | Files installed into the device's boot partition when preparing the | 1427 | Files installed into the device's boot partition when preparing the |
1428 | image using the Wic tool with the ``bootimg-partition`` or | 1428 | image using the Wic tool with the ``bootimg_partition`` or |
1429 | ``bootimg-efi`` source plugin. | 1429 | ``bootimg_efi`` source plugin. |
1430 | 1430 | ||
1431 | BSP Kernel Recipe Example | 1431 | BSP Kernel Recipe Example |
1432 | ------------------------- | 1432 | ------------------------- |
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst index fced0e170c..07170537b4 100644 --- a/documentation/dev-manual/wic.rst +++ b/documentation/dev-manual/wic.rst | |||
@@ -309,7 +309,7 @@ Here are the actual partition language commands used in the | |||
309 | 309 | ||
310 | # short-description: Create an EFI disk image for genericx86* | 310 | # short-description: Create an EFI disk image for genericx86* |
311 | # long-description: Creates a partitioned EFI disk image for genericx86* machines | 311 | # long-description: Creates a partitioned EFI disk image for genericx86* machines |
312 | part /boot --source bootimg-efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024 | 312 | part /boot --source bootimg_efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024 |
313 | part / --source rootfs --ondisk sda --fstype=ext4 --label platform --align 1024 --use-uuid | 313 | part / --source rootfs --ondisk sda --fstype=ext4 --label platform --align 1024 --use-uuid |
314 | part swap --ondisk sda --size 44 --label swap1 --fstype=swap | 314 | part swap --ondisk sda --size 44 --label swap1 --fstype=swap |
315 | 315 | ||
@@ -348,7 +348,7 @@ populate a specific Wic image partition. | |||
348 | 348 | ||
349 | Source plugins are subclasses of the ``SourcePlugin`` class, which is | 349 | Source plugins are subclasses of the ``SourcePlugin`` class, which is |
350 | defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example, | 350 | defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example, |
351 | the ``BootimgEFIPlugin`` source plugin found in the ``bootimg-efi.py`` | 351 | the ``BootimgEFIPlugin`` source plugin found in the ``bootimg_efi.py`` |
352 | file is a subclass of the ``SourcePlugin`` class, which is found in the | 352 | file is a subclass of the ``SourcePlugin`` class, which is found in the |
353 | ``pluginbase.py`` file. | 353 | ``pluginbase.py`` file. |
354 | 354 | ||
@@ -365,14 +365,14 @@ implementation, it looks for the plugin with the same name as the | |||
365 | partition. For example, if the partition is set up using the following | 365 | partition. For example, if the partition is set up using the following |
366 | command in a kickstart file:: | 366 | command in a kickstart file:: |
367 | 367 | ||
368 | part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024 | 368 | part /boot --source bootimg_pcbios --ondisk sda --label boot --active --align 1024 |
369 | 369 | ||
370 | The methods defined as class | 370 | The methods defined as class |
371 | members of the matching source plugin (i.e. ``bootimg-pcbios``) in the | 371 | members of the matching source plugin (i.e. ``bootimg_pcbios``) in the |
372 | ``bootimg-pcbios.py`` plugin file are used. | 372 | ``bootimg_pcbios.py`` plugin file are used. |
373 | 373 | ||
374 | To be more concrete, here is the corresponding plugin definition from | 374 | To be more concrete, here is the corresponding plugin definition from |
375 | the ``bootimg-pcbios.py`` file for the previous command along with an | 375 | the ``bootimg_pcbios.py`` file for the previous command along with an |
376 | example method called by the Wic implementation when it needs to prepare | 376 | example method called by the Wic implementation when it needs to prepare |
377 | a partition using an implementation-specific function:: | 377 | a partition using an implementation-specific function:: |
378 | 378 | ||
@@ -384,7 +384,7 @@ a partition using an implementation-specific function:: | |||
384 | Create MBR boot partition and install syslinux on it. | 384 | Create MBR boot partition and install syslinux on it. |
385 | """ | 385 | """ |
386 | 386 | ||
387 | name = 'bootimg-pcbios' | 387 | name = 'bootimg_pcbios' |
388 | . | 388 | . |
389 | . | 389 | . |
390 | . | 390 | . |
@@ -550,7 +550,7 @@ changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The | |||
550 | example changes the following two lines and leaves the remaining lines | 550 | example changes the following two lines and leaves the remaining lines |
551 | untouched:: | 551 | untouched:: |
552 | 552 | ||
553 | part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024 | 553 | part /boot --source bootimg_pcbios --ondisk sdb --label boot --active --align 1024 |
554 | part / --source rootfs --ondisk sdb --fstype=ext4 --label platform --align 1024 --use-uuid | 554 | part / --source rootfs --ondisk sdb --fstype=ext4 --label platform --align 1024 --use-uuid |
555 | 555 | ||
556 | Once the lines are changed, the | 556 | Once the lines are changed, the |
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index d12b1c56bd..662121ed9c 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -3265,7 +3265,7 @@ The variables used by this class are: | |||
3265 | :oe_git:`meta/conf/image-uefi.conf | 3265 | :oe_git:`meta/conf/image-uefi.conf |
3266 | </openembedded-core/tree/meta/conf/image-uefi.conf>` | 3266 | </openembedded-core/tree/meta/conf/image-uefi.conf>` |
3267 | - :term:`IMAGE_EFI_BOOT_FILES`: files to install to EFI boot partition | 3267 | - :term:`IMAGE_EFI_BOOT_FILES`: files to install to EFI boot partition |
3268 | created by the ``bootimg-efi`` Wic plugin | 3268 | created by the ``bootimg_efi`` Wic plugin |
3269 | - :term:`INITRAMFS_IMAGE`: initramfs recipe name | 3269 | - :term:`INITRAMFS_IMAGE`: initramfs recipe name |
3270 | - :term:`KERNEL_DEVICETREE`: optional devicetree files to embed into UKI | 3270 | - :term:`KERNEL_DEVICETREE`: optional devicetree files to embed into UKI |
3271 | - :term:`UKIFY_CMD`: `ukify | 3271 | - :term:`UKIFY_CMD`: `ukify |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 3369bf67f7..cefbfd096a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -3839,7 +3839,7 @@ system and gives an overview of their function and contents. | |||
3839 | :term:`IMAGE_BOOT_FILES` | 3839 | :term:`IMAGE_BOOT_FILES` |
3840 | A space-separated list of files installed into the boot partition | 3840 | A space-separated list of files installed into the boot partition |
3841 | when preparing an image using the Wic tool with the | 3841 | when preparing an image using the Wic tool with the |
3842 | ``bootimg-partition`` source plugin. By default, | 3842 | ``bootimg_partition`` source plugin. By default, |
3843 | the files are | 3843 | the files are |
3844 | installed under the same name as the source files. To change the | 3844 | installed under the same name as the source files. To change the |
3845 | installed name, separate it from the original name with a semi-colon | 3845 | installed name, separate it from the original name with a semi-colon |
@@ -3917,7 +3917,7 @@ system and gives an overview of their function and contents. | |||
3917 | :term:`IMAGE_EFI_BOOT_FILES` | 3917 | :term:`IMAGE_EFI_BOOT_FILES` |
3918 | A space-separated list of files installed into the boot partition | 3918 | A space-separated list of files installed into the boot partition |
3919 | when preparing an image using the Wic tool with the | 3919 | when preparing an image using the Wic tool with the |
3920 | ``bootimg-efi`` source plugin. By default, | 3920 | ``bootimg_efi`` source plugin. By default, |
3921 | the files are | 3921 | the files are |
3922 | installed under the same name as the source files. To change the | 3922 | installed under the same name as the source files. To change the |
3923 | installed name, separate it from the original name with a semi-colon | 3923 | installed name, separate it from the original name with a semi-colon |