diff options
Diffstat (limited to 'documentation/ref-manual/kickstart.rst')
| -rw-r--r-- | documentation/ref-manual/kickstart.rst | 72 |
1 files changed, 46 insertions, 26 deletions
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 843292b528..297887805c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -54,8 +54,9 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or .. note:: 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. + ``--use-uuid`` and non-root *mountpoint*, including swap. The default + configuration of BusyBox in OpenEmbedded supports this, but this may + be disabled in custom configurations. Here is an example that uses "/" as the mountpoint. The command uses ``--ondisk`` to force the partition onto the ``sdb`` disk:: @@ -65,24 +66,28 @@ Here is an example that uses "/" as the mountpoint. The command uses Here is a list that describes other supported options you can use with the ``part`` and ``partition`` commands: -- ``--size``: The minimum partition size in MBytes. Specify an - integer value such as 500. Do not append the number with "MB". You do - not need this option if you use ``--source``. +- ``--size``: The minimum partition size. Specify as an integer value + optionally followed by one of the units "k" / "K" for kibibyte, + "M" for mebibyte and "G" for gibibyte. The default unit if none is + given is "M". 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``. +- ``--fixed-size``: The exact partition size. Specify as an integer + value optionally followed by one of the units "k" / "K" for kibibyte, + "M" for mebibyte and "G" for gibibyte. The default unit if none is + given is "M". Cannot be specify together 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 of the data that populates the partition. The most common value for this option is "rootfs", but you can use any value that maps to a valid source plugin. For information on the source plugins, - see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" + see the ":ref:`dev-manual/wic:using the wic plugin interface`" section in the Yocto Project Development Tasks Manual. If you use ``--source rootfs``, Wic 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 + to by the ``-r`` command-line option or the equivalent root filesystem derived from the ``-e`` command-line option. The filesystem type used to create the partition is driven by the value of the ``--fstype`` option specified for the partition. See the entry on ``--fstype`` @@ -91,7 +96,7 @@ the ``part`` and ``partition`` commands: If you use ``--source plugin-name``, Wic creates a partition as large as needed and fills it with the contents of the partition that is generated by the specified plugin name using the data pointed to by - the ``-r`` command-line option or the equivalent rootfs derived from + the ``-r`` command-line option or the equivalent root filesystem derived from the ``-e`` command-line option. Exactly what those contents are and filesystem type used are dependent on the given plugin implementation. @@ -106,18 +111,22 @@ the ``part`` and ``partition`` commands: - ``--fstype``: Sets the file system type for the partition. Valid values are: - - ``ext4`` + - ``btrfs`` - - ``ext3`` + - ``erofs`` - ``ext2`` - - ``btrfs`` + - ``ext3`` + + - ``ext4`` - ``squashfs`` - ``swap`` + - ``vfat`` + - ``--fsoptions``: Specifies a free-form string of options to be used when mounting the filesystem. This string is copied into the ``/etc/fstab`` file of the installed system and should be enclosed in @@ -132,10 +141,13 @@ the ``part`` and ``partition`` commands: - ``--align (in KBytes)``: This option is a Wic-specific option that says to start partitions on boundaries given x KBytes. -- ``--offset (in KBytes)``: This option is a Wic-specific option that +- ``--offset``: This option is a Wic-specific option 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. + 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 a Wic-specific option. Using the option reserves space for the partition and causes it to become @@ -149,7 +161,10 @@ the ``part`` and ``partition`` commands: - ``--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 exceed the size specified by the ``--size`` - option. The default value is 10 Mbytes. + option. The default value is 10M. Specify as an integer value + optionally followed by one of the units "k" / "K" for kibibyte, "M" + for mebibyte and "G" for gibibyte. The default unit if none is given + is "M". - ``--overhead-factor``: This option is a Wic-specific option that multiplies the size of the partition by the option's value. You must @@ -162,7 +177,7 @@ the ``part`` and ``partition`` commands: - ``--part-type``: This option is a Wic-specific option that specifies the partition type globally unique identifier (GUID) for GPT partitions. You can find the list of partition type GUIDs at - https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. + :wikipedia:`GUID_Partition_Table#Partition_type_GUIDs`. - ``--use-uuid``: This option is a Wic-specific option that causes Wic to generate a random GUID for the partition. The generated @@ -196,19 +211,24 @@ supports the following options: .. note:: Bootloader functionality and boot partitions are implemented by the - various - --source - plugins that implement bootloader functionality. The bootloader + various source plugins that implement bootloader functionality. The bootloader command essentially provides a means of modifying bootloader configuration. -- ``--timeout``: Specifies the number of seconds before the - bootloader times out and boots the default option. - - ``--append``: Specifies kernel parameters. These parameters will be - added to the syslinux ``APPEND`` or ``grub`` kernel command line. + added to the syslinux :term:`APPEND` or ``grub`` kernel command line. - ``--configfile``: Specifies a user-defined configuration file for the bootloader. You can provide a full pathname for the file or a - file that exists in the ``canned-wks`` folder. This option overrides + file located in the ``canned-wks`` folder. This option overrides all other bootloader options. + +- ``--ptable``: Specifies the partition table format. Valid values are: + + - ``msdos`` + + - ``gpt`` + +- ``--timeout``: Specifies the number of seconds before the + bootloader times out and boots the default option. + |