diff options
Diffstat (limited to 'scripts/lib/wic/help.py')
-rw-r--r-- | scripts/lib/wic/help.py | 50 |
1 files changed, 44 insertions, 6 deletions
diff --git a/scripts/lib/wic/help.py b/scripts/lib/wic/help.py index 4ff7470a6a..2e3061f343 100644 --- a/scripts/lib/wic/help.py +++ b/scripts/lib/wic/help.py | |||
@@ -544,18 +544,18 @@ DESCRIPTION | |||
544 | the --source param given to that partition. For example, if the | 544 | the --source param given to that partition. For example, if the |
545 | partition is set up like this: | 545 | partition is set up like this: |
546 | 546 | ||
547 | part /boot --source bootimg-pcbios ... | 547 | part /boot --source bootimg_pcbios ... |
548 | 548 | ||
549 | then the methods defined as class members of the plugin having the | 549 | then the methods defined as class members of the plugin having the |
550 | matching bootimg-pcbios .name class member would be used. | 550 | matching bootimg_pcbios .name class member would be used. |
551 | 551 | ||
552 | To be more concrete, here's the plugin definition that would match | 552 | To be more concrete, here's the plugin definition that would match |
553 | a '--source bootimg-pcbios' usage, along with an example method | 553 | a '--source bootimg_pcbios' usage, along with an example method |
554 | that would be called by the wic implementation when it needed to | 554 | that would be called by the wic implementation when it needed to |
555 | invoke an implementation-specific partition-preparation function: | 555 | invoke an implementation-specific partition-preparation function: |
556 | 556 | ||
557 | class BootimgPcbiosPlugin(SourcePlugin): | 557 | class BootimgPcbiosPlugin(SourcePlugin): |
558 | name = 'bootimg-pcbios' | 558 | name = 'bootimg_pcbios' |
559 | 559 | ||
560 | @classmethod | 560 | @classmethod |
561 | def do_prepare_partition(self, part, ...) | 561 | def do_prepare_partition(self, part, ...) |
@@ -794,7 +794,7 @@ DESCRIPTION | |||
794 | 794 | ||
795 | Here is a content of test.wks: | 795 | Here is a content of test.wks: |
796 | 796 | ||
797 | part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024 | 797 | part /boot --source bootimg_pcbios --ondisk sda --label boot --active --align 1024 |
798 | part / --source rootfs --ondisk sda --fstype=ext3 --label platform --align 1024 | 798 | part / --source rootfs --ondisk sda --fstype=ext3 --label platform --align 1024 |
799 | 799 | ||
800 | bootloader --timeout=0 --append="rootwait rootfstype=ext3 video=vesafb vga=0x318 console=tty0" | 800 | bootloader --timeout=0 --append="rootwait rootfstype=ext3 video=vesafb vga=0x318 console=tty0" |
@@ -916,6 +916,10 @@ DESCRIPTION | |||
916 | will create empty partition. --size parameter has | 916 | will create empty partition. --size parameter has |
917 | to be used to specify size of empty partition. | 917 | to be used to specify size of empty partition. |
918 | 918 | ||
919 | --sourceparams: This option is specific to wic. Supply additional | ||
920 | parameters to the source plugin in | ||
921 | key1=value1,key2 format. | ||
922 | |||
919 | --ondisk or --ondrive: Forces the partition to be created on | 923 | --ondisk or --ondrive: Forces the partition to be created on |
920 | a particular disk. | 924 | a particular disk. |
921 | 925 | ||
@@ -932,6 +936,7 @@ DESCRIPTION | |||
932 | squashfs | 936 | squashfs |
933 | erofs | 937 | erofs |
934 | swap | 938 | swap |
939 | none | ||
935 | 940 | ||
936 | --fsoptions: Specifies a free-form string of options to be | 941 | --fsoptions: Specifies a free-form string of options to be |
937 | used when mounting the filesystem. This string | 942 | used when mounting the filesystem. This string |
@@ -940,6 +945,12 @@ DESCRIPTION | |||
940 | quotes. If not specified, the default string is | 945 | quotes. If not specified, the default string is |
941 | "defaults". | 946 | "defaults". |
942 | 947 | ||
948 | --fspassno: Specifies the order in which filesystem checks are done | ||
949 | at boot time by fsck. See fs_passno parameter of | ||
950 | fstab(5). This parameter will be copied into the | ||
951 | /etc/fstab file of the installed system. If not | ||
952 | specified the default value of "0" will be used. | ||
953 | |||
943 | --label label: Specifies the label to give to the filesystem | 954 | --label label: Specifies the label to give to the filesystem |
944 | to be made on the partition. If the given | 955 | to be made on the partition. If the given |
945 | label is already in use by another filesystem, | 956 | label is already in use by another filesystem, |
@@ -959,6 +970,14 @@ DESCRIPTION | |||
959 | to start a partition on an x KBytes | 970 | to start a partition on an x KBytes |
960 | boundary. | 971 | boundary. |
961 | 972 | ||
973 | --offset: This option is specific to wic that says to place a partition | ||
974 | at exactly the specified offset. If the partition cannot be | ||
975 | placed at the specified offset, the image build will fail. | ||
976 | Specify as an integer value optionally followed by one of the | ||
977 | units s/S for 512 byte sector, k/K for kibibyte, M for | ||
978 | mebibyte and G for gibibyte. The default unit if none is | ||
979 | given is k. | ||
980 | |||
962 | --no-table: This option is specific to wic. Space will be | 981 | --no-table: This option is specific to wic. Space will be |
963 | reserved for the partition and it will be | 982 | reserved for the partition and it will be |
964 | populated but it will not be added to the | 983 | populated but it will not be added to the |
@@ -1039,6 +1058,18 @@ DESCRIPTION | |||
1039 | not take effect when --mkfs-extraopts is used. This should be taken into | 1058 | not take effect when --mkfs-extraopts is used. This should be taken into |
1040 | account when using --mkfs-extraopts. | 1059 | account when using --mkfs-extraopts. |
1041 | 1060 | ||
1061 | --type: This option is specific to wic. Valid values are 'primary', | ||
1062 | 'logical'. For msdos partition tables, this option specifies | ||
1063 | the partition type. | ||
1064 | |||
1065 | --hidden: This option is specific to wic. This option sets the | ||
1066 | RequiredPartition bit (bit 0) on GPT partitions. | ||
1067 | |||
1068 | --mbr: This option is specific to wic. This option is used with the | ||
1069 | gpt-hybrid partition type that uses both a GPT partition and | ||
1070 | an MBR header. Partitions with this flag will be included in | ||
1071 | this MBR header. | ||
1072 | |||
1042 | * bootloader | 1073 | * bootloader |
1043 | 1074 | ||
1044 | This command allows the user to specify various bootloader | 1075 | This command allows the user to specify various bootloader |
@@ -1057,6 +1088,13 @@ DESCRIPTION | |||
1057 | file. Using this option will override any other | 1088 | file. Using this option will override any other |
1058 | bootloader option. | 1089 | bootloader option. |
1059 | 1090 | ||
1091 | --ptable: Specifies the partition table format. Valid values are | ||
1092 | 'msdos', 'gpt', 'gpt-hybrid'. | ||
1093 | |||
1094 | --source: Specifies the source plugin. If not specified, the | ||
1095 | --source value will be copied from the partition that has | ||
1096 | /boot as mountpoint. | ||
1097 | |||
1060 | Note that bootloader functionality and boot partitions are | 1098 | Note that bootloader functionality and boot partitions are |
1061 | implemented by the various --source plugins that implement | 1099 | implemented by the various --source plugins that implement |
1062 | bootloader functionality; the bootloader command essentially | 1100 | bootloader functionality; the bootloader command essentially |
@@ -1112,7 +1150,7 @@ COMMAND: | |||
1112 | TOPIC: | 1150 | TOPIC: |
1113 | overview - Presents an overall overview of Wic | 1151 | overview - Presents an overall overview of Wic |
1114 | plugins - Presents an overview and API for Wic plugins | 1152 | plugins - Presents an overview and API for Wic plugins |
1115 | kickstart - Presents a Wic kicstart file reference | 1153 | kickstart - Presents a Wic kickstart file reference |
1116 | 1154 | ||
1117 | 1155 | ||
1118 | Examples: | 1156 | Examples: |