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>
This commit is contained in:
Antonin Godard 2025-07-29 11:56:49 +02:00 committed by Richard Purdie
parent 7dc3a0be6f
commit 1887b330c3
4 changed files with 13 additions and 13 deletions

View File

@ -1425,8 +1425,8 @@ Project Reference Manual.
- :term:`IMAGE_BOOT_FILES`:
Files installed into the device's boot partition when preparing the
image using the Wic tool with the ``bootimg-partition`` or
``bootimg-efi`` source plugin.
image using the Wic tool with the ``bootimg_partition`` or
``bootimg_efi`` source plugin.
BSP Kernel Recipe Example
-------------------------

View File

@ -309,7 +309,7 @@ Here are the actual partition language commands used in the
# short-description: Create an EFI disk image for genericx86*
# long-description: Creates a partitioned EFI disk image for genericx86* machines
part /boot --source bootimg-efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024
part /boot --source bootimg_efi --sourceparams="loader=grub-efi" --ondisk sda --label msdos --active --align 1024
part / --source rootfs --ondisk sda --fstype=ext4 --label platform --align 1024 --use-uuid
part swap --ondisk sda --size 44 --label swap1 --fstype=swap
@ -348,7 +348,7 @@ populate a specific Wic image partition.
Source plugins are subclasses of the ``SourcePlugin`` class, which is
defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example,
the ``BootimgEFIPlugin`` source plugin found in the ``bootimg-efi.py``
the ``BootimgEFIPlugin`` source plugin found in the ``bootimg_efi.py``
file is a subclass of the ``SourcePlugin`` class, which is found in the
``pluginbase.py`` file.
@ -365,14 +365,14 @@ implementation, it looks for the plugin with the same name as the
partition. For example, if the partition is set up using the following
command in a kickstart file::
part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024
part /boot --source bootimg_pcbios --ondisk sda --label boot --active --align 1024
The methods defined as class
members of the matching source plugin (i.e. ``bootimg-pcbios``) in the
``bootimg-pcbios.py`` plugin file are used.
members of the matching source plugin (i.e. ``bootimg_pcbios``) in the
``bootimg_pcbios.py`` plugin file are used.
To be more concrete, here is the corresponding plugin definition from
the ``bootimg-pcbios.py`` file for the previous command along with an
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::
@ -384,7 +384,7 @@ a partition using an implementation-specific function::
Create MBR boot partition and install syslinux on it.
"""
name = 'bootimg-pcbios'
name = 'bootimg_pcbios'
.
.
.
@ -550,7 +550,7 @@ changes all instances of "``--ondisk sda``" to "``--ondisk sdb``". The
example changes the following two lines and leaves the remaining lines
untouched::
part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024
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
Once the lines are changed, the

View File

@ -3265,7 +3265,7 @@ The variables used by this class are:
:oe_git:`meta/conf/image-uefi.conf
</openembedded-core/tree/meta/conf/image-uefi.conf>`
- :term:`IMAGE_EFI_BOOT_FILES`: files to install to EFI boot partition
created by the ``bootimg-efi`` Wic plugin
created by the ``bootimg_efi`` Wic plugin
- :term:`INITRAMFS_IMAGE`: initramfs recipe name
- :term:`KERNEL_DEVICETREE`: optional devicetree files to embed into UKI
- :term:`UKIFY_CMD`: `ukify

View File

@ -3839,7 +3839,7 @@ system and gives an overview of their function and contents.
:term:`IMAGE_BOOT_FILES`
A space-separated list of files installed into the boot partition
when preparing an image using the Wic tool with the
``bootimg-partition`` source plugin. By default,
``bootimg_partition`` source plugin. By default,
the files are
installed under the same name as the source files. To change the
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.
:term:`IMAGE_EFI_BOOT_FILES`
A space-separated list of files installed into the boot partition
when preparing an image using the Wic tool with the
``bootimg-efi`` source plugin. By default,
``bootimg_efi`` source plugin. By default,
the files are
installed under the same name as the source files. To change the
installed name, separate it from the original name with a semi-colon