summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-07-29 11:56:49 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-08-08 23:41:10 +0100
commit1887b330c3a04723472a43497d58201b27b86f05 (patch)
tree6a12321dceaff7d9b9910b7de469c41daa4673c1 /documentation/dev-manual
parent7dc3a0be6f70a3f6549e5bd279cd5521a8f3636b (diff)
downloadpoky-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/dev-manual')
-rw-r--r--documentation/dev-manual/wic.rst16
1 files changed, 8 insertions, 8 deletions
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
349Source plugins are subclasses of the ``SourcePlugin`` class, which is 349Source plugins are subclasses of the ``SourcePlugin`` class, which is
350defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example, 350defined in the ``poky/scripts/lib/wic/pluginbase.py`` file. For example,
351the ``BootimgEFIPlugin`` source plugin found in the ``bootimg-efi.py`` 351the ``BootimgEFIPlugin`` source plugin found in the ``bootimg_efi.py``
352file is a subclass of the ``SourcePlugin`` class, which is found in the 352file 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
365partition. For example, if the partition is set up using the following 365partition. For example, if the partition is set up using the following
366command in a kickstart file:: 366command 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
370The methods defined as class 370The methods defined as class
371members of the matching source plugin (i.e. ``bootimg-pcbios``) in the 371members 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
374To be more concrete, here is the corresponding plugin definition from 374To be more concrete, here is the corresponding plugin definition from
375the ``bootimg-pcbios.py`` file for the previous command along with an 375the ``bootimg_pcbios.py`` file for the previous command along with an
376example method called by the Wic implementation when it needs to prepare 376example method called by the Wic implementation when it needs to prepare
377a partition using an implementation-specific function:: 377a 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
550example changes the following two lines and leaves the remaining lines 550example changes the following two lines and leaves the remaining lines
551untouched:: 551untouched::
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
556Once the lines are changed, the 556Once the lines are changed, the