From e701fdeeba7e94d6e1658a83c2bf2885799e6a49 Mon Sep 17 00:00:00 2001 From: Kristi Rifenbark Date: Fri, 23 Feb 2018 13:04:31 -0800 Subject: ref-manual: Updated partition command options Fixed [YOCTO #11525] Created a note for more explanation for how the mount program understands the PARTUUID syntax used with --use-uuid. Added four missing options. (From yocto-docs rev: d8adf537d305dd55e841dd993c36ee60b5896adb) Signed-off-by: Kristi Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-kickstart.xml | 82 +++++++++++++++++++++++++----- 1 file changed, 68 insertions(+), 14 deletions(-) (limited to 'documentation') diff --git a/documentation/ref-manual/ref-kickstart.xml b/documentation/ref-manual/ref-kickstart.xml index ab3d1b8ef1..fd3de5b41d 100644 --- a/documentation/ref-manual/ref-kickstart.xml +++ b/documentation/ref-manual/ref-kickstart.xml @@ -43,7 +43,7 @@ Command: part or partition - Either of these commands create a partition on the system and use + Either of these commands creates a partition on the system and uses the following syntax: part [mntpoint] @@ -55,7 +55,7 @@ The mntpoint is - where the partition will be mounted and must be of one of the + where the partition is mounted and must be in one of the following forms: @@ -64,7 +64,7 @@ swap: - The created partition is used as swap space. + The created partition is used as swap space @@ -74,13 +74,22 @@ partition to automatically be mounted. Wic achieves this by adding entries to the filesystem table (fstab) during image generation. - In order for wic to generate a valid fstab, you must also provide + In order for Wic to generate a valid fstab, you must also provide one of the --ondrive, --ondisk, or --use-uuid partition options as part of the command. - Here is an example using "/" as the mountpoint. - The command uses "--ondisk" to force the partition onto the + + The mount program must understand the PARTUUID syntax you use + with --use-uuid and non-root + mountpoint, including swap. + The busybox versions of these application are currently + excluded. + + Here is an example that uses "/" as the + mountpoint. + The command uses --ondisk to force the + partition onto the sdb disk: part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 @@ -100,6 +109,14 @@ You do not need this option if you use --source. + + --fixed-size: + The exact partition size in MBytes. + You cannot specify with --size. + An error occurs when assembling the disk image if the + partition data is larger than + --fixed-size. + --source: This option is a Wic-specific option that names the source @@ -112,7 +129,7 @@ If you use --source rootfs, Wic - creates a partition as large as needed and to fill it with + creates a partition as large as needed and fills it with the contents of the root filesystem pointed to by the -r command-line option or the equivalent rootfs derived from the -e @@ -131,8 +148,8 @@ -r command-line option or the equivalent rootfs derived from the -e command-line option. - Exactly what those contents and filesystem type end up - being are dependent on the given plug-in implementation. + Exactly what those contents are and filesystem type used are + dependent on the given plug-in implementation. If you do not use the --source @@ -174,7 +191,7 @@ --fsoptions: Specifies a free-form string of options to be used when mounting the filesystem. - This string will be copied into the + This string is copied into the /etc/fstab file of the installed system and should be enclosed in quotes. If not specified, the default string is "defaults". @@ -192,9 +209,9 @@ --align (in KBytes): - This option is a Wic-specific option that says to start a - partition on an x KBytes - boundary. + This option is a Wic-specific option that says to start + partitions on boundaries given + x KBytes. --no-table: @@ -203,11 +220,18 @@ causes it to become populated. However, the partition is not added to the partition table. + + --exclude-path: + This option is a Wic-specific option that excludes the given + relative path from the resulting image. + This option is only effective with the rootfs source + plug-in. + --extra-space: This option is a Wic-specific option that adds extra space after the space filled by the content of the partition. - The final size can go beyond the size specified by the + The final size can exceed the size specified by the --size option. The default value is 10 Mbytes. @@ -218,6 +242,11 @@ You must supply a value greater than or equal to "1". The default value is "1.3". + + --part-name: + This option is a Wic-specific option that specifies a name + for GPT partitions. + --part-type: This option is a Wic-specific option that specifies the @@ -238,6 +267,31 @@ This option is a Wic-specific option that specifies the partition UUID. + + --fsuuid: + This option is a Wic-specific option that specifies the + filesystem UUID. + You can generate or modify + WKS_FILE + with this option if a preconfigured filesystem UUID is + added to the kernel command line in the bootloader + configuration before you run Wic. + + + --system-id: + This option is a Wic-specific option that specifies the + partition system ID, which is a one byte long, hexadecimal + parameter with or without the 0x prefix. + + + --mkfs-extraopts: + This option specifies additional options to pass to the + mkfs utility. + Some default options for certain filesystems do not take + effect. + See Wic's help on kickstart + (i.e. wic help kickstart). + -- cgit v1.2.3-54-g00ecf