diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-14 22:48:44 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:35 +0100 |
commit | 292598164a304a3da3288e6fb8963f13045d1e7f (patch) | |
tree | efedbbdc16cb2e0978a4d40e6a6294e32b0e496f /documentation/ref-manual/ref-kickstart.rst | |
parent | d313d972bf592de77f2af13cb3fc4226247cb1a1 (diff) | |
download | poky-292598164a304a3da3288e6fb8963f13045d1e7f.tar.gz |
sphinx: ref-manual links fixes and many other cleanups to import
(From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e)
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-kickstart.rst')
-rw-r--r-- | documentation/ref-manual/ref-kickstart.rst | 57 |
1 files changed, 31 insertions, 26 deletions
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst index 271e6e8509..45222de05b 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/ref-kickstart.rst | |||
@@ -30,7 +30,13 @@ Command: part or partition | |||
30 | ========================== | 30 | ========================== |
31 | 31 | ||
32 | Either of these commands creates a partition on the system and uses the | 32 | Either of these commands creates a partition on the system and uses the |
33 | following syntax: part [mntpoint] partition [mntpoint] If you do not | 33 | following syntax: |
34 | :: | ||
35 | |||
36 | part [mntpoint] | ||
37 | partition [mntpoint] | ||
38 | |||
39 | If you do not | ||
34 | provide mntpoint, Wic creates a partition but does not mount it. | 40 | provide mntpoint, Wic creates a partition but does not mount it. |
35 | 41 | ||
36 | The ``mntpoint`` is where the partition is mounted and must be in one of | 42 | The ``mntpoint`` is where the partition is mounted and must be in one of |
@@ -62,20 +68,19 @@ Here is an example that uses "/" as the mountpoint. The command uses | |||
62 | Here is a list that describes other supported options you can use with | 68 | Here is a list that describes other supported options you can use with |
63 | the ``part`` and ``partition`` commands: | 69 | the ``part`` and ``partition`` commands: |
64 | 70 | ||
65 | - *``--size``:* The minimum partition size in MBytes. Specify an | 71 | - ``--size``: The minimum partition size in MBytes. Specify an |
66 | integer value such as 500. Do not append the number with "MB". You do | 72 | integer value such as 500. Do not append the number with "MB". You do |
67 | not need this option if you use ``--source``. | 73 | not need this option if you use ``--source``. |
68 | 74 | ||
69 | - *``--fixed-size``:* The exact partition size in MBytes. You cannot | 75 | - ``--fixed-size``: The exact partition size in MBytes. You cannot |
70 | specify with ``--size``. An error occurs when assembling the disk | 76 | specify with ``--size``. An error occurs when assembling the disk |
71 | image if the partition data is larger than ``--fixed-size``. | 77 | image if the partition data is larger than ``--fixed-size``. |
72 | 78 | ||
73 | - *``--source``:* This option is a Wic-specific option that names the | 79 | - ``--source``: This option is a Wic-specific option that names the |
74 | source of the data that populates the partition. The most common | 80 | source of the data that populates the partition. The most common |
75 | value for this option is "rootfs", but you can use any value that | 81 | value for this option is "rootfs", but you can use any value that |
76 | maps to a valid source plugin. For information on the source plugins, | 82 | maps to a valid source plugin. For information on the source plugins, |
77 | see the "`Using the Wic Plugins | 83 | see the ":ref:`dev-manual/dev-manual-common-tasks:using the wic plugin interface`" |
78 | Interface <&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plugin-interface>`__" | ||
79 | section in the Yocto Project Development Tasks Manual. | 84 | section in the Yocto Project Development Tasks Manual. |
80 | 85 | ||
81 | If you use ``--source rootfs``, Wic creates a partition as large as | 86 | If you use ``--source rootfs``, Wic creates a partition as large as |
@@ -98,10 +103,10 @@ the ``part`` and ``partition`` commands: | |||
98 | creates an empty partition. Consequently, you must use the ``--size`` | 103 | creates an empty partition. Consequently, you must use the ``--size`` |
99 | option to specify the size of the empty partition. | 104 | option to specify the size of the empty partition. |
100 | 105 | ||
101 | - *``--ondisk`` or ``--ondrive``:* Forces the partition to be created | 106 | - ``--ondisk`` or ``--ondrive``: Forces the partition to be created |
102 | on a particular disk. | 107 | on a particular disk. |
103 | 108 | ||
104 | - *``--fstype``:* Sets the file system type for the partition. Valid | 109 | - ``--fstype``: Sets the file system type for the partition. Valid |
105 | values are: | 110 | values are: |
106 | 111 | ||
107 | - ``ext4`` | 112 | - ``ext4`` |
@@ -116,66 +121,66 @@ the ``part`` and ``partition`` commands: | |||
116 | 121 | ||
117 | - ``swap`` | 122 | - ``swap`` |
118 | 123 | ||
119 | - *``--fsoptions``:* Specifies a free-form string of options to be used | 124 | - ``--fsoptions``: Specifies a free-form string of options to be used |
120 | when mounting the filesystem. This string is copied into the | 125 | when mounting the filesystem. This string is copied into the |
121 | ``/etc/fstab`` file of the installed system and should be enclosed in | 126 | ``/etc/fstab`` file of the installed system and should be enclosed in |
122 | quotes. If not specified, the default string is "defaults". | 127 | quotes. If not specified, the default string is "defaults". |
123 | 128 | ||
124 | - *``--label label``:* Specifies the label to give to the filesystem to | 129 | - ``--label label``: Specifies the label to give to the filesystem to |
125 | be made on the partition. If the given label is already in use by | 130 | be made on the partition. If the given label is already in use by |
126 | another filesystem, a new label is created for the partition. | 131 | another filesystem, a new label is created for the partition. |
127 | 132 | ||
128 | - *``--active``:* Marks the partition as active. | 133 | - ``--active``: Marks the partition as active. |
129 | 134 | ||
130 | - *``--align (in KBytes)``:* This option is a Wic-specific option that | 135 | - ``--align (in KBytes)``: This option is a Wic-specific option that |
131 | says to start partitions on boundaries given x KBytes. | 136 | says to start partitions on boundaries given x KBytes. |
132 | 137 | ||
133 | - *``--no-table``:* This option is a Wic-specific option. Using the | 138 | - ``--no-table``: This option is a Wic-specific option. Using the |
134 | option reserves space for the partition and causes it to become | 139 | option reserves space for the partition and causes it to become |
135 | populated. However, the partition is not added to the partition | 140 | populated. However, the partition is not added to the partition |
136 | table. | 141 | table. |
137 | 142 | ||
138 | - *``--exclude-path``:* This option is a Wic-specific option that | 143 | - ``--exclude-path``: This option is a Wic-specific option that |
139 | excludes the given relative path from the resulting image. This | 144 | excludes the given relative path from the resulting image. This |
140 | option is only effective with the rootfs source plugin. | 145 | option is only effective with the rootfs source plugin. |
141 | 146 | ||
142 | - *``--extra-space``:* This option is a Wic-specific option that adds | 147 | - ``--extra-space``: This option is a Wic-specific option that adds |
143 | extra space after the space filled by the content of the partition. | 148 | extra space after the space filled by the content of the partition. |
144 | The final size can exceed the size specified by the ``--size`` | 149 | The final size can exceed the size specified by the ``--size`` |
145 | option. The default value is 10 Mbytes. | 150 | option. The default value is 10 Mbytes. |
146 | 151 | ||
147 | - *``--overhead-factor``:* This option is a Wic-specific option that | 152 | - ``--overhead-factor``: This option is a Wic-specific option that |
148 | multiplies the size of the partition by the option's value. You must | 153 | multiplies the size of the partition by the option's value. You must |
149 | supply a value greater than or equal to "1". The default value is | 154 | supply a value greater than or equal to "1". The default value is |
150 | "1.3". | 155 | "1.3". |
151 | 156 | ||
152 | - *``--part-name``:* This option is a Wic-specific option that | 157 | - ``--part-name``: This option is a Wic-specific option that |
153 | specifies a name for GPT partitions. | 158 | specifies a name for GPT partitions. |
154 | 159 | ||
155 | - *``--part-type``:* This option is a Wic-specific option that | 160 | - ``--part-type``: This option is a Wic-specific option that |
156 | specifies the partition type globally unique identifier (GUID) for | 161 | specifies the partition type globally unique identifier (GUID) for |
157 | GPT partitions. You can find the list of partition type GUIDs at | 162 | GPT partitions. You can find the list of partition type GUIDs at |
158 | http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. | 163 | http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. |
159 | 164 | ||
160 | - *``--use-uuid``:* This option is a Wic-specific option that causes | 165 | - ``--use-uuid``: This option is a Wic-specific option that causes |
161 | Wic to generate a random GUID for the partition. The generated | 166 | Wic to generate a random GUID for the partition. The generated |
162 | identifier is used in the bootloader configuration to specify the | 167 | identifier is used in the bootloader configuration to specify the |
163 | root partition. | 168 | root partition. |
164 | 169 | ||
165 | - *``--uuid``:* This option is a Wic-specific option that specifies the | 170 | - ``--uuid``: This option is a Wic-specific option that specifies the |
166 | partition UUID. | 171 | partition UUID. |
167 | 172 | ||
168 | - *``--fsuuid``:* This option is a Wic-specific option that specifies | 173 | - ``--fsuuid``: This option is a Wic-specific option that specifies |
169 | the filesystem UUID. You can generate or modify | 174 | the filesystem UUID. You can generate or modify |
170 | :term:`WKS_FILE` with this option if a preconfigured | 175 | :term:`WKS_FILE` with this option if a preconfigured |
171 | filesystem UUID is added to the kernel command line in the bootloader | 176 | filesystem UUID is added to the kernel command line in the bootloader |
172 | configuration before you run Wic. | 177 | configuration before you run Wic. |
173 | 178 | ||
174 | - *``--system-id``:* This option is a Wic-specific option that | 179 | - ``--system-id``: This option is a Wic-specific option that |
175 | specifies the partition system ID, which is a one byte long, | 180 | specifies the partition system ID, which is a one byte long, |
176 | hexadecimal parameter with or without the 0x prefix. | 181 | hexadecimal parameter with or without the 0x prefix. |
177 | 182 | ||
178 | - *``--mkfs-extraopts``:* This option specifies additional options to | 183 | - ``--mkfs-extraopts``: This option specifies additional options to |
179 | pass to the ``mkfs`` utility. Some default options for certain | 184 | pass to the ``mkfs`` utility. Some default options for certain |
180 | filesystems do not take effect. See Wic's help on kickstart (i.e. | 185 | filesystems do not take effect. See Wic's help on kickstart (i.e. |
181 | ``wic help kickstart``). | 186 | ``wic help kickstart``). |
@@ -195,13 +200,13 @@ supports the following options: | |||
195 | command essentially provides a means of modifying bootloader | 200 | command essentially provides a means of modifying bootloader |
196 | configuration. | 201 | configuration. |
197 | 202 | ||
198 | - *``--timeout``:* Specifies the number of seconds before the | 203 | - ``--timeout``: Specifies the number of seconds before the |
199 | bootloader times out and boots the default option. | 204 | bootloader times out and boots the default option. |
200 | 205 | ||
201 | - *``--append``:* Specifies kernel parameters. These parameters will be | 206 | - ``--append``: Specifies kernel parameters. These parameters will be |
202 | added to the syslinux ``APPEND`` or ``grub`` kernel command line. | 207 | added to the syslinux ``APPEND`` or ``grub`` kernel command line. |
203 | 208 | ||
204 | - *``--configfile``:* Specifies a user-defined configuration file for | 209 | - ``--configfile``: Specifies a user-defined configuration file for |
205 | the bootloader. You can provide a full pathname for the file or a | 210 | the bootloader. You can provide a full pathname for the file or a |
206 | file that exists in the ``canned-wks`` folder. This option overrides | 211 | file that exists in the ``canned-wks`` folder. This option overrides |
207 | all other bootloader options. | 212 | all other bootloader options. |