summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/kickstart.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/kickstart.rst')
-rw-r--r--documentation/ref-manual/kickstart.rst80
1 files changed, 49 insertions, 31 deletions
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index 472820f165..297887805c 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -30,10 +30,9 @@ Command: part or partition
30========================== 30==========================
31 31
32Either of these commands creates a partition on the system and uses the 32Either of these commands creates a partition on the system and uses the
33following syntax: 33following syntax::
34::
35 34
36 part [mntpoint] 35 part [mntpoint]
37 partition [mntpoint] 36 partition [mntpoint]
38 37
39If you do not 38If you do not
@@ -55,36 +54,40 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or
55.. note:: 54.. note::
56 55
57 The mount program must understand the PARTUUID syntax you use with 56 The mount program must understand the PARTUUID syntax you use with
58 ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox 57 ``--use-uuid`` and non-root *mountpoint*, including swap. The default
59 versions of these application are currently excluded. 58 configuration of BusyBox in OpenEmbedded supports this, but this may
59 be disabled in custom configurations.
60 60
61Here is an example that uses "/" as the mountpoint. The command uses 61Here is an example that uses "/" as the mountpoint. The command uses
62``--ondisk`` to force the partition onto the ``sdb`` disk: 62``--ondisk`` to force the partition onto the ``sdb`` disk::
63::
64 63
65 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 64 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
66 65
67Here is a list that describes other supported options you can use with 66Here is a list that describes other supported options you can use with
68the ``part`` and ``partition`` commands: 67the ``part`` and ``partition`` commands:
69 68
70- ``--size``: The minimum partition size in MBytes. Specify an 69- ``--size``: The minimum partition size. Specify as an integer value
71 integer value such as 500. Do not append the number with "MB". You do 70 optionally followed by one of the units "k" / "K" for kibibyte,
72 not need this option if you use ``--source``. 71 "M" for mebibyte and "G" for gibibyte. The default unit if none is
72 given is "M". You do not need this option if you use ``--source``.
73 73
74- ``--fixed-size``: The exact partition size in MBytes. You cannot 74- ``--fixed-size``: The exact partition size. Specify as an integer
75 specify with ``--size``. An error occurs when assembling the disk 75 value optionally followed by one of the units "k" / "K" for kibibyte,
76 image if the partition data is larger than ``--fixed-size``. 76 "M" for mebibyte and "G" for gibibyte. The default unit if none is
77 given is "M". Cannot be specify together with ``--size``. An error
78 occurs when assembling the disk image if the partition data is larger
79 than ``--fixed-size``.
77 80
78- ``--source``: This option is a Wic-specific option that names the 81- ``--source``: This option is a Wic-specific option that names the
79 source of the data that populates the partition. The most common 82 source of the data that populates the partition. The most common
80 value for this option is "rootfs", but you can use any value that 83 value for this option is "rootfs", but you can use any value that
81 maps to a valid source plugin. For information on the source plugins, 84 maps to a valid source plugin. For information on the source plugins,
82 see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" 85 see the ":ref:`dev-manual/wic:using the wic plugin interface`"
83 section in the Yocto Project Development Tasks Manual. 86 section in the Yocto Project Development Tasks Manual.
84 87
85 If you use ``--source rootfs``, Wic creates a partition as large as 88 If you use ``--source rootfs``, Wic creates a partition as large as
86 needed and fills it with the contents of the root filesystem pointed 89 needed and fills it with the contents of the root filesystem pointed
87 to by the ``-r`` command-line option or the equivalent rootfs derived 90 to by the ``-r`` command-line option or the equivalent root filesystem derived
88 from the ``-e`` command-line option. The filesystem type used to 91 from the ``-e`` command-line option. The filesystem type used to
89 create the partition is driven by the value of the ``--fstype`` 92 create the partition is driven by the value of the ``--fstype``
90 option specified for the partition. See the entry on ``--fstype`` 93 option specified for the partition. See the entry on ``--fstype``
@@ -93,7 +96,7 @@ the ``part`` and ``partition`` commands:
93 If you use ``--source plugin-name``, Wic creates a partition as large 96 If you use ``--source plugin-name``, Wic creates a partition as large
94 as needed and fills it with the contents of the partition that is 97 as needed and fills it with the contents of the partition that is
95 generated by the specified plugin name using the data pointed to by 98 generated by the specified plugin name using the data pointed to by
96 the ``-r`` command-line option or the equivalent rootfs derived from 99 the ``-r`` command-line option or the equivalent root filesystem derived from
97 the ``-e`` command-line option. Exactly what those contents are and 100 the ``-e`` command-line option. Exactly what those contents are and
98 filesystem type used are dependent on the given plugin 101 filesystem type used are dependent on the given plugin
99 implementation. 102 implementation.
@@ -108,18 +111,22 @@ the ``part`` and ``partition`` commands:
108- ``--fstype``: Sets the file system type for the partition. Valid 111- ``--fstype``: Sets the file system type for the partition. Valid
109 values are: 112 values are:
110 113
111 - ``ext4`` 114 - ``btrfs``
112 115
113 - ``ext3`` 116 - ``erofs``
114 117
115 - ``ext2`` 118 - ``ext2``
116 119
117 - ``btrfs`` 120 - ``ext3``
121
122 - ``ext4``
118 123
119 - ``squashfs`` 124 - ``squashfs``
120 125
121 - ``swap`` 126 - ``swap``
122 127
128 - ``vfat``
129
123- ``--fsoptions``: Specifies a free-form string of options to be used 130- ``--fsoptions``: Specifies a free-form string of options to be used
124 when mounting the filesystem. This string is copied into the 131 when mounting the filesystem. This string is copied into the
125 ``/etc/fstab`` file of the installed system and should be enclosed in 132 ``/etc/fstab`` file of the installed system and should be enclosed in
@@ -134,10 +141,13 @@ the ``part`` and ``partition`` commands:
134- ``--align (in KBytes)``: This option is a Wic-specific option that 141- ``--align (in KBytes)``: This option is a Wic-specific option that
135 says to start partitions on boundaries given x KBytes. 142 says to start partitions on boundaries given x KBytes.
136 143
137- ``--offset (in KBytes)``: This option is a Wic-specific option that 144- ``--offset``: This option is a Wic-specific option that
138 says to place a partition at exactly the specified offset. If the 145 says to place a partition at exactly the specified offset. If the
139 partition cannot be placed at the specified offset, the image build 146 partition cannot be placed at the specified offset, the image build
140 will fail. 147 will fail. Specify as an integer value optionally followed by one of
148 the units "s" / "S" for 512 byte sector, "k" / "K" for kibibyte, "M"
149 for mebibyte and "G" for gibibyte. The default unit if none is given
150 is "k".
141 151
142- ``--no-table``: This option is a Wic-specific option. Using the 152- ``--no-table``: This option is a Wic-specific option. Using the
143 option reserves space for the partition and causes it to become 153 option reserves space for the partition and causes it to become
@@ -151,7 +161,10 @@ the ``part`` and ``partition`` commands:
151- ``--extra-space``: This option is a Wic-specific option that adds 161- ``--extra-space``: This option is a Wic-specific option that adds
152 extra space after the space filled by the content of the partition. 162 extra space after the space filled by the content of the partition.
153 The final size can exceed the size specified by the ``--size`` 163 The final size can exceed the size specified by the ``--size``
154 option. The default value is 10 Mbytes. 164 option. The default value is 10M. Specify as an integer value
165 optionally followed by one of the units "k" / "K" for kibibyte, "M"
166 for mebibyte and "G" for gibibyte. The default unit if none is given
167 is "M".
155 168
156- ``--overhead-factor``: This option is a Wic-specific option that 169- ``--overhead-factor``: This option is a Wic-specific option that
157 multiplies the size of the partition by the option's value. You must 170 multiplies the size of the partition by the option's value. You must
@@ -164,7 +177,7 @@ the ``part`` and ``partition`` commands:
164- ``--part-type``: This option is a Wic-specific option that 177- ``--part-type``: This option is a Wic-specific option that
165 specifies the partition type globally unique identifier (GUID) for 178 specifies the partition type globally unique identifier (GUID) for
166 GPT partitions. You can find the list of partition type GUIDs at 179 GPT partitions. You can find the list of partition type GUIDs at
167 https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. 180 :wikipedia:`GUID_Partition_Table#Partition_type_GUIDs`.
168 181
169- ``--use-uuid``: This option is a Wic-specific option that causes 182- ``--use-uuid``: This option is a Wic-specific option that causes
170 Wic to generate a random GUID for the partition. The generated 183 Wic to generate a random GUID for the partition. The generated
@@ -198,19 +211,24 @@ supports the following options:
198.. note:: 211.. note::
199 212
200 Bootloader functionality and boot partitions are implemented by the 213 Bootloader functionality and boot partitions are implemented by the
201 various 214 various source plugins that implement bootloader functionality. The bootloader
202 --source
203 plugins that implement bootloader functionality. The bootloader
204 command essentially provides a means of modifying bootloader 215 command essentially provides a means of modifying bootloader
205 configuration. 216 configuration.
206 217
207- ``--timeout``: Specifies the number of seconds before the
208 bootloader times out and boots the default option.
209
210- ``--append``: Specifies kernel parameters. These parameters will be 218- ``--append``: Specifies kernel parameters. These parameters will be
211 added to the syslinux ``APPEND`` or ``grub`` kernel command line. 219 added to the syslinux :term:`APPEND` or ``grub`` kernel command line.
212 220
213- ``--configfile``: Specifies a user-defined configuration file for 221- ``--configfile``: Specifies a user-defined configuration file for
214 the bootloader. You can provide a full pathname for the file or a 222 the bootloader. You can provide a full pathname for the file or a
215 file that exists in the ``canned-wks`` folder. This option overrides 223 file located in the ``canned-wks`` folder. This option overrides
216 all other bootloader options. 224 all other bootloader options.
225
226- ``--ptable``: Specifies the partition table format. Valid values are:
227
228 - ``msdos``
229
230 - ``gpt``
231
232- ``--timeout``: Specifies the number of seconds before the
233 bootloader times out and boots the default option.
234