mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-04-20 09:32:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Updated partition command options

Browse Source 
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>
This commit is contained in:
Kristi Rifenbark
2018-02-23 13:04:31 -08:00
committed by Richard Purdie
parent 35549a7a45
commit e701fdeeba
1 changed files with 68 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
documentation/ref-manual/ref-kickstart.xml
View File

@@ -43,7 +43,7 @@
<title>Command: part or partition</title>
<para>
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:
<literallayout class='monospaced'>
part [<replaceable>mntpoint</replaceable>]
@@ -55,7 +55,7 @@
<para>
The <filename><replaceable>mntpoint</replaceable></filename> 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:
<itemizedlist>
<listitem><para>
@@ -64,7 +64,7 @@
</para></listitem>
<listitem><para>
<filename>swap</filename>:
The created partition is used as swap space.
The created partition is used as swap space
</para></listitem>
</itemizedlist>
</para>
@@ -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 <filename>--ondrive</filename>,
<filename>--ondisk</filename>, or
<filename>--use-uuid</filename> 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
<note>
The mount program must understand the PARTUUID syntax you use
with <filename>--use-uuid</filename> and non-root
<replaceable>mountpoint</replaceable>, including swap.
The busybox versions of these application are currently
excluded.
</note>
Here is an example that uses "/" as the
<replaceable>mountpoint</replaceable>.
The command uses <filename>--ondisk</filename> to force the
partition onto the
<filename>sdb</filename> disk:
<literallayout class='monospaced'>
part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
@@ -100,6 +109,14 @@
You do not need this option if you use
<filename>--source</filename>.
</para></listitem>
<listitem><para>
<emphasis><filename>--fixed-size</filename>:</emphasis>
The exact partition size in MBytes.
You cannot specify with <filename>--size</filename>.
An error occurs when assembling the disk image if the
partition data is larger than
<filename>--fixed-size</filename>.
</para></listitem>
<listitem><para>
<emphasis><filename>--source</filename>:</emphasis>
This option is a Wic-specific option that names the source
@@ -112,7 +129,7 @@
</para>
<para>If you use <filename>--source rootfs</filename>, 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
<filename>-r</filename> command-line option or the
equivalent rootfs derived from the <filename>-e</filename>
@@ -131,8 +148,8 @@
<filename>-r</filename> command-line option or the
equivalent rootfs derived from the <filename>-e</filename>
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.
</para>
<para>If you do not use the <filename>--source</filename>
@@ -174,7 +191,7 @@
<emphasis><filename>--fsoptions</filename>:</emphasis>
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
<filename>/etc/fstab</filename> file of the installed
system and should be enclosed in quotes.
If not specified, the default string is "defaults".
@@ -192,9 +209,9 @@
</para></listitem>
<listitem><para>
<emphasis><filename>--align (in KBytes)</filename>:</emphasis>
This option is a Wic-specific option that says to start a
partition on an <replaceable>x</replaceable> KBytes
boundary.
This option is a Wic-specific option that says to start
partitions on boundaries given
<replaceable>x</replaceable> KBytes.
</para></listitem>
<listitem><para>
<emphasis><filename>--no-table</filename>:</emphasis>
@@ -203,11 +220,18 @@
causes it to become populated.
However, the partition is not added to the partition table.
</para></listitem>
<listitem><para>
<emphasis><filename>--exclude-path</filename>:</emphasis>
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.
</para></listitem>
<listitem><para>
<emphasis><filename>--extra-space</filename>:</emphasis>
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
<filename>--size</filename> option.
The default value is 10 Mbytes.
</para></listitem>
@@ -218,6 +242,11 @@
You must supply a value greater than or equal to "1".
The default value is "1.3".
</para></listitem>
<listitem><para>
<emphasis><filename>--part-name</filename>:</emphasis>
This option is a Wic-specific option that specifies a name
for GPT partitions.
</para></listitem>
<listitem><para>
<emphasis><filename>--part-type</filename>:</emphasis>
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.
</para></listitem>
<listitem><para>
<emphasis><filename>--fsuuid</filename>:</emphasis>
This option is a Wic-specific option that specifies the
filesystem UUID.
You can generate or modify
<link linkend='var-WKS_FILE'><filename>WKS_FILE</filename></link>
with this option if a preconfigured filesystem UUID is
added to the kernel command line in the bootloader
configuration before you run Wic.
</para></listitem>
<listitem><para>
<emphasis><filename>--system-id</filename>:</emphasis>
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.
</para></listitem>
<listitem><para>
<emphasis><filename>--mkfs-extraopts</filename>:</emphasis>
This option specifies additional options to pass to the
<filename>mkfs</filename> utility.
Some default options for certain filesystems do not take
effect.
See Wic's help on kickstart
(i.e. <filename>wic help kickstart</filename>).
</para></listitem>
</itemizedlist>
</para>
</section>