diff mbox series

[v2] wic: add documentation for existing options to help.py

Message ID 20241225122918.31867-2-code@stefan-gloor.ch
State New
Headers show
Series [v2] wic: add documentation for existing options to help.py | expand

Commit Message

Stefan Gloor Dec. 25, 2024, 12:29 p.m. UTC 
Add wic kickstart help for undocumented options for part/partition and
bootloader command.

Signed-off-by: Stefan Gloor <code@stefan-gloor.ch>
---
 scripts/lib/wic/help.py | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
diff mbox series

Patch

diff --git a/scripts/lib/wic/help.py b/scripts/lib/wic/help.py
index 163535e431..9180d75a92 100644
--- a/scripts/lib/wic/help.py
+++ b/scripts/lib/wic/help.py
@@ -916,6 +916,10 @@  DESCRIPTION
                    will create empty partition. --size parameter has
                    to be used to specify size of empty partition.
 
+         --sourceparams: This option is specific to wic. Supply additional
+                         parameters to the source plugin in
+                         key1=value1,key2 format.
+
          --ondisk or --ondrive: Forces the partition to be created on
                                 a particular disk.
 
@@ -932,6 +936,7 @@  DESCRIPTION
              squashfs
              erofs
              swap
+             none
 
          --fsoptions: Specifies a free-form string of options to be
                       used when mounting the filesystem. This string
@@ -965,6 +970,14 @@  DESCRIPTION
                               to start a partition on an x KBytes
                               boundary.
 
+         --offset: This option is specific to wic that says to place a partition
+                   at exactly the specified offset. If the partition cannot be
+                   placed at the specified offset, the image build will fail.
+                   Specify as an integer value optionally followed by one of the
+                   units s/S for 512 byte sector, k/K for kibibyte, M for
+                   mebibyte and G for gibibyte. The default unit if none is
+                   given is k.
+
          --no-table: This option is specific to wic. Space will be
                      reserved for the partition and it will be
                      populated but it will not be added to the
@@ -1045,6 +1058,18 @@  DESCRIPTION
                            not take effect when --mkfs-extraopts is used. This should be taken into
                            account when using --mkfs-extraopts.
 
+         --type: This option is specific to wic. Valid values are 'primary',
+                 'logical'. For msdos partition tables, this option specifies
+                 the partition type.
+
+         --hidden: This option is specific to wic. This option sets the
+                   RequiredPartition bit (bit 0) on GPT partitions.
+
+         --mbr: This option is specific to wic. This option is used with the
+                gpt-hybrid partition type that uses both a GPT partition and
+                an MBR header. Partitions with this flag will be included in
+                this MBR header.
+
     * bootloader
 
       This command allows the user to specify various bootloader
@@ -1063,6 +1088,13 @@  DESCRIPTION
                       file. Using this option will override any other
                       bootloader option.
 
+        --ptable: Specifies the partition table format. Valid values are
+                  'msdos', 'gpt', 'gpt-hybrid'.
+
+        --source: Specifies the source plugin. If not specified, the
+                  --source value will be copied from the partition that has
+                  /boot as mountpoint.
+
       Note that bootloader functionality and boot partitions are
       implemented by the various --source plugins that implement
       bootloader functionality; the bootloader command essentially