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

kickstart: document which options accept units

Browse Source 
Document which units are accepted as parameters for the four options
that accept units. Also be pedantic about using binary instead of
decimal prefixes so readers don't have to wonder.

(From yocto-docs rev: 6b1d7d102ed3b509dfb3e43a3d7a27226f504df5)

Signed-off-by: Olaf Mandel <o.mandel@menlosystems.com>
Reviewed-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Olaf Mandel
2021-08-13 08:48:55 +00:00
committed by Richard Purdie
parent 2eb5550db4
commit 0b8f844c8c
1 changed files with 19 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
documentation/ref-manual/kickstart.rst
View File

@@ -65,13 +65,17 @@ 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
@@ -134,10 +138,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
@@ -151,7 +158,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