diff mbox series

[1/3] ref-manual/kickstart.rst: add extra-partition-space

Message ID 20250908140048.352088-1-pierre-loup.gosse@smile.fr
State Under Review
Headers show
Series [1/3] ref-manual/kickstart.rst: add extra-partition-space | expand

Commit Message

Pierre-loup GOSSE Sept. 8, 2025, 2 p.m. UTC
From: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>

After commits 47533f20a7ec ("wic: rename wks flag --extra-space to
--extra-filesystem-space") and c7f51c23fd268 ("wic: add
--extra-partition-space option to set unused space") in openembedded-core,
document the new Wic-specific option extra-partition-space and rename
the extra-space option to extra-filesystem-space.

CC: Alexander Kanavin <alex.kanavin@gmail.com>
Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
---
 documentation/ref-manual/kickstart.rst | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

Comments

Antonin Godard Sept. 10, 2025, 8:47 a.m. UTC | #1
On Mon Sep 8, 2025 at 4:00 PM CEST, pierre-loup.gosse via lists.yoctoproject.org wrote:
> From: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
>
> After commits 47533f20a7ec ("wic: rename wks flag --extra-space to
> --extra-filesystem-space") and c7f51c23fd268 ("wic: add
> --extra-partition-space option to set unused space") in openembedded-core,
> document the new Wic-specific option extra-partition-space and rename
> the extra-space option to extra-filesystem-space.
>
> CC: Alexander Kanavin <alex.kanavin@gmail.com>
> Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr>
> ---
>  documentation/ref-manual/kickstart.rst | 12 +++++++++++-
>  1 file changed, 11 insertions(+), 1 deletion(-)
>
> diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
> index 297887805..80e2f9d84 100644
> --- a/documentation/ref-manual/kickstart.rst
> +++ b/documentation/ref-manual/kickstart.rst
> @@ -158,7 +158,7 @@ the ``part`` and ``partition`` commands:
>     excludes the given relative path from the resulting image. This
>     option is only effective with the rootfs source plugin.
>  
> --  ``--extra-space``: This option is a Wic-specific option that adds
> +-  ``--extra-filesystem-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 10M. Specify as an integer value
> @@ -166,6 +166,16 @@ the ``part`` and ``partition`` commands:
>     for mebibyte and "G" for gibibyte. The default unit if none is given
>     is "M".
>  
> +-  ``--extra-partition-space``: This option is a Wic-specific option that adds
> +   extra empty space after the space filled by the filesystem.
> +   With ``--fixed-size`` option, the extra partition space is removed from the
> +   filesystem size. Otherwise (with or without ``--size`` flag), the extra
> +   partition space is added to the final partition size.
> +   The default value is 0M. 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
>     supply a value greater than or equal to "1". The default value is

For the entire series:

Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>

Thank you!
Antonin
diff mbox series

Patch

diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index 297887805..80e2f9d84 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -158,7 +158,7 @@  the ``part`` and ``partition`` commands:
    excludes the given relative path from the resulting image. This
    option is only effective with the rootfs source plugin.
 
--  ``--extra-space``: This option is a Wic-specific option that adds
+-  ``--extra-filesystem-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 10M. Specify as an integer value
@@ -166,6 +166,16 @@  the ``part`` and ``partition`` commands:
    for mebibyte and "G" for gibibyte. The default unit if none is given
    is "M".
 
+-  ``--extra-partition-space``: This option is a Wic-specific option that adds
+   extra empty space after the space filled by the filesystem.
+   With ``--fixed-size`` option, the extra partition space is removed from the
+   filesystem size. Otherwise (with or without ``--size`` flag), the extra
+   partition space is added to the final partition size.
+   The default value is 0M. 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
    supply a value greater than or equal to "1". The default value is