summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-kickstart.xml
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi@buzzcollectivemarketing.com>2018-02-23 13:04:31 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-03 08:35:25 +0000
commite701fdeeba7e94d6e1658a83c2bf2885799e6a49 (patch)
tree19339498456a48932220cb9124348cc7d5d7003b /documentation/ref-manual/ref-kickstart.xml
parent35549a7a45ef63f87f37b0a45a0a9fe1c2c59af0 (diff)
downloadpoky-e701fdeeba7e94d6e1658a83c2bf2885799e6a49.tar.gz
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 <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-kickstart.xml')
-rw-r--r--documentation/ref-manual/ref-kickstart.xml82
1 files changed, 68 insertions, 14 deletions
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 @@
43 <title>Command: part or partition</title> 43 <title>Command: part or partition</title>
44 44
45 <para> 45 <para>
46 Either of these commands create a partition on the system and use 46 Either of these commands creates a partition on the system and uses
47 the following syntax: 47 the following syntax:
48 <literallayout class='monospaced'> 48 <literallayout class='monospaced'>
49 part [<replaceable>mntpoint</replaceable>] 49 part [<replaceable>mntpoint</replaceable>]
@@ -55,7 +55,7 @@
55 55
56 <para> 56 <para>
57 The <filename><replaceable>mntpoint</replaceable></filename> is 57 The <filename><replaceable>mntpoint</replaceable></filename> is
58 where the partition will be mounted and must be of one of the 58 where the partition is mounted and must be in one of the
59 following forms: 59 following forms:
60 <itemizedlist> 60 <itemizedlist>
61 <listitem><para> 61 <listitem><para>
@@ -64,7 +64,7 @@
64 </para></listitem> 64 </para></listitem>
65 <listitem><para> 65 <listitem><para>
66 <filename>swap</filename>: 66 <filename>swap</filename>:
67 The created partition is used as swap space. 67 The created partition is used as swap space
68 </para></listitem> 68 </para></listitem>
69 </itemizedlist> 69 </itemizedlist>
70 </para> 70 </para>
@@ -74,13 +74,22 @@
74 partition to automatically be mounted. 74 partition to automatically be mounted.
75 Wic achieves this by adding entries to the filesystem table (fstab) 75 Wic achieves this by adding entries to the filesystem table (fstab)
76 during image generation. 76 during image generation.
77 In order for wic to generate a valid fstab, you must also provide 77 In order for Wic to generate a valid fstab, you must also provide
78 one of the <filename>--ondrive</filename>, 78 one of the <filename>--ondrive</filename>,
79 <filename>--ondisk</filename>, or 79 <filename>--ondisk</filename>, or
80 <filename>--use-uuid</filename> partition options as part of the 80 <filename>--use-uuid</filename> partition options as part of the
81 command. 81 command.
82 Here is an example using "/" as the mountpoint. 82 <note>
83 The command uses "--ondisk" to force the partition onto the 83 The mount program must understand the PARTUUID syntax you use
84 with <filename>--use-uuid</filename> and non-root
85 <replaceable>mountpoint</replaceable>, including swap.
86 The busybox versions of these application are currently
87 excluded.
88 </note>
89 Here is an example that uses "/" as the
90 <replaceable>mountpoint</replaceable>.
91 The command uses <filename>--ondisk</filename> to force the
92 partition onto the
84 <filename>sdb</filename> disk: 93 <filename>sdb</filename> disk:
85 <literallayout class='monospaced'> 94 <literallayout class='monospaced'>
86 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 95 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
@@ -101,6 +110,14 @@
101 <filename>--source</filename>. 110 <filename>--source</filename>.
102 </para></listitem> 111 </para></listitem>
103 <listitem><para> 112 <listitem><para>
113 <emphasis><filename>--fixed-size</filename>:</emphasis>
114 The exact partition size in MBytes.
115 You cannot specify with <filename>--size</filename>.
116 An error occurs when assembling the disk image if the
117 partition data is larger than
118 <filename>--fixed-size</filename>.
119 </para></listitem>
120 <listitem><para>
104 <emphasis><filename>--source</filename>:</emphasis> 121 <emphasis><filename>--source</filename>:</emphasis>
105 This option is a Wic-specific option that names the source 122 This option is a Wic-specific option that names the source
106 of the data that populates the partition. 123 of the data that populates the partition.
@@ -112,7 +129,7 @@
112 </para> 129 </para>
113 130
114 <para>If you use <filename>--source rootfs</filename>, Wic 131 <para>If you use <filename>--source rootfs</filename>, Wic
115 creates a partition as large as needed and to fill it with 132 creates a partition as large as needed and fills it with
116 the contents of the root filesystem pointed to by the 133 the contents of the root filesystem pointed to by the
117 <filename>-r</filename> command-line option or the 134 <filename>-r</filename> command-line option or the
118 equivalent rootfs derived from the <filename>-e</filename> 135 equivalent rootfs derived from the <filename>-e</filename>
@@ -131,8 +148,8 @@
131 <filename>-r</filename> command-line option or the 148 <filename>-r</filename> command-line option or the
132 equivalent rootfs derived from the <filename>-e</filename> 149 equivalent rootfs derived from the <filename>-e</filename>
133 command-line option. 150 command-line option.
134 Exactly what those contents and filesystem type end up 151 Exactly what those contents are and filesystem type used are
135 being are dependent on the given plug-in implementation. 152 dependent on the given plug-in implementation.
136 </para> 153 </para>
137 154
138 <para>If you do not use the <filename>--source</filename> 155 <para>If you do not use the <filename>--source</filename>
@@ -174,7 +191,7 @@
174 <emphasis><filename>--fsoptions</filename>:</emphasis> 191 <emphasis><filename>--fsoptions</filename>:</emphasis>
175 Specifies a free-form string of options to be used when 192 Specifies a free-form string of options to be used when
176 mounting the filesystem. 193 mounting the filesystem.
177 This string will be copied into the 194 This string is copied into the
178 <filename>/etc/fstab</filename> file of the installed 195 <filename>/etc/fstab</filename> file of the installed
179 system and should be enclosed in quotes. 196 system and should be enclosed in quotes.
180 If not specified, the default string is "defaults". 197 If not specified, the default string is "defaults".
@@ -192,9 +209,9 @@
192 </para></listitem> 209 </para></listitem>
193 <listitem><para> 210 <listitem><para>
194 <emphasis><filename>--align (in KBytes)</filename>:</emphasis> 211 <emphasis><filename>--align (in KBytes)</filename>:</emphasis>
195 This option is a Wic-specific option that says to start a 212 This option is a Wic-specific option that says to start
196 partition on an <replaceable>x</replaceable> KBytes 213 partitions on boundaries given
197 boundary. 214 <replaceable>x</replaceable> KBytes.
198 </para></listitem> 215 </para></listitem>
199 <listitem><para> 216 <listitem><para>
200 <emphasis><filename>--no-table</filename>:</emphasis> 217 <emphasis><filename>--no-table</filename>:</emphasis>
@@ -204,10 +221,17 @@
204 However, the partition is not added to the partition table. 221 However, the partition is not added to the partition table.
205 </para></listitem> 222 </para></listitem>
206 <listitem><para> 223 <listitem><para>
224 <emphasis><filename>--exclude-path</filename>:</emphasis>
225 This option is a Wic-specific option that excludes the given
226 relative path from the resulting image.
227 This option is only effective with the rootfs source
228 plug-in.
229 </para></listitem>
230 <listitem><para>
207 <emphasis><filename>--extra-space</filename>:</emphasis> 231 <emphasis><filename>--extra-space</filename>:</emphasis>
208 This option is a Wic-specific option that adds extra space 232 This option is a Wic-specific option that adds extra space
209 after the space filled by the content of the partition. 233 after the space filled by the content of the partition.
210 The final size can go beyond the size specified by the 234 The final size can exceed the size specified by the
211 <filename>--size</filename> option. 235 <filename>--size</filename> option.
212 The default value is 10 Mbytes. 236 The default value is 10 Mbytes.
213 </para></listitem> 237 </para></listitem>
@@ -219,6 +243,11 @@
219 The default value is "1.3". 243 The default value is "1.3".
220 </para></listitem> 244 </para></listitem>
221 <listitem><para> 245 <listitem><para>
246 <emphasis><filename>--part-name</filename>:</emphasis>
247 This option is a Wic-specific option that specifies a name
248 for GPT partitions.
249 </para></listitem>
250 <listitem><para>
222 <emphasis><filename>--part-type</filename>:</emphasis> 251 <emphasis><filename>--part-type</filename>:</emphasis>
223 This option is a Wic-specific option that specifies the 252 This option is a Wic-specific option that specifies the
224 partition type globally unique identifier (GUID) for GPT 253 partition type globally unique identifier (GUID) for GPT
@@ -238,6 +267,31 @@
238 This option is a Wic-specific option that specifies the 267 This option is a Wic-specific option that specifies the
239 partition UUID. 268 partition UUID.
240 </para></listitem> 269 </para></listitem>
270 <listitem><para>
271 <emphasis><filename>--fsuuid</filename>:</emphasis>
272 This option is a Wic-specific option that specifies the
273 filesystem UUID.
274 You can generate or modify
275 <link linkend='var-WKS_FILE'><filename>WKS_FILE</filename></link>
276 with this option if a preconfigured filesystem UUID is
277 added to the kernel command line in the bootloader
278 configuration before you run Wic.
279 </para></listitem>
280 <listitem><para>
281 <emphasis><filename>--system-id</filename>:</emphasis>
282 This option is a Wic-specific option that specifies the
283 partition system ID, which is a one byte long, hexadecimal
284 parameter with or without the 0x prefix.
285 </para></listitem>
286 <listitem><para>
287 <emphasis><filename>--mkfs-extraopts</filename>:</emphasis>
288 This option specifies additional options to pass to the
289 <filename>mkfs</filename> utility.
290 Some default options for certain filesystems do not take
291 effect.
292 See Wic's help on kickstart
293 (i.e. <filename>wic help kickstart</filename>).
294 </para></listitem>
241 </itemizedlist> 295 </itemizedlist>
242 </para> 296 </para>
243 </section> 297 </section>