diff mbox series

[3/3] kickstart: Expand label and part-name doc

Message ID 20230406084417.34931-3-dit.kozmaj@kynetics.com
State New
Headers show
Series [1/3] wic: use part_name when defined | expand

Commit Message

Dit Kozmaj April 6, 2023, 8:44 a.m. UTC
From: Dit Kozmaj <dit.kozmaj@kynetics.com>

Update --label and --part-name documentation to reflect the
behaviour with GPT partition format.

Signed-off-by: Dit Kozmaj <dit.kozmaj@kynetics.com>
---
 documentation/ref-manual/kickstart.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index 297887805c..a01f035cd2 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -135,6 +135,8 @@  the ``part`` and ``partition`` commands:
 -  ``--label label``: Specifies the label to give to the filesystem to
    be made on the partition. If the given label is already in use by
    another filesystem, a new label is created for the partition.
+   If the partition table format is GPT and the ``--part-name`` is not
+   defined the partition name is set as the value of  ``--label``.
 
 -  ``--active``: Marks the partition as active.
 
@@ -172,7 +174,9 @@  the ``part`` and ``partition`` commands:
    "1.3".
 
 -  ``--part-name``: This option is a Wic-specific option that
-   specifies a name for GPT partitions.
+   specifies a name for GPT partitions. If both ``--part-name`` and
+   ``--label`` are defined, the partition name is set to the value of
+   ``--part-name``.
 
 -  ``--part-type``: This option is a Wic-specific option that
    specifies the partition type globally unique identifier (GUID) for