diff mbox series

[34/45] xfs_mkfs: document the new zoned options in the man page

Message ID 20250409075557.3535745-35-hch@lst.de (mailing list archive)
State New
Headers show
Series [01/45] xfs: generalize the freespace and reserved blocks handling | expand

Commit Message

Christoph Hellwig April 9, 2025, 7:55 a.m. UTC
Add documentation for the zoned file system specific options.

Signed-off-by: Christoph Hellwig <hch@lst.de>
---
 man/man8/mkfs.xfs.8.in | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Darrick J. Wong April 9, 2025, 7 p.m. UTC | #1
On Wed, Apr 09, 2025 at 09:55:37AM +0200, Christoph Hellwig wrote:
> Add documentation for the zoned file system specific options.
> 
> Signed-off-by: Christoph Hellwig <hch@lst.de>
> ---
>  man/man8/mkfs.xfs.8.in | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
> index 37e3a88e7ac7..27df7f4546c7 100644
> --- a/man/man8/mkfs.xfs.8.in
> +++ b/man/man8/mkfs.xfs.8.in
> @@ -1248,6 +1248,23 @@ The magic value of
>  .I 0
>  forces use of the older rtgroups geometry calculations that is used for
>  mechanical storage.
> +.TP
> +.BI zoned= value
> +Controls if the zoned allocator is used for the realtime device.
> +The value is either 0 to disable the feature, or 1 to enable it.
> +Defaults to 1 for zoned block device, else 0.
> +.TP
> +.BI start= value
> +Controls the start of the internal realtime section.  Defaults to 0
> +for conventional block devices, or the start of the first sequential
> +required zone for zoned block devices.
> +This option is only valid if the zoned realtime allocator is used.
> +.TP
> +.BI reserved= value
> +Controls the amount of space in the realtime section that is reserved for
> +internal use by garbage collection and reorganization algorithms.
> +Defaults 0 if not set.

"Defaults to 0"

With that fixed,
Reviewed-by: "Darrick J. Wong" <djwong@kernel.org>

--D

> +This option is only valid if the zoned realtime allocator is used.
>  .RE
>  .PP
>  .PD 0
> -- 
> 2.47.2
> 
>
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
index 37e3a88e7ac7..27df7f4546c7 100644
--- a/man/man8/mkfs.xfs.8.in
+++ b/man/man8/mkfs.xfs.8.in
@@ -1248,6 +1248,23 @@  The magic value of
 .I 0
 forces use of the older rtgroups geometry calculations that is used for
 mechanical storage.
+.TP
+.BI zoned= value
+Controls if the zoned allocator is used for the realtime device.
+The value is either 0 to disable the feature, or 1 to enable it.
+Defaults to 1 for zoned block device, else 0.
+.TP
+.BI start= value
+Controls the start of the internal realtime section.  Defaults to 0
+for conventional block devices, or the start of the first sequential
+required zone for zoned block devices.
+This option is only valid if the zoned realtime allocator is used.
+.TP
+.BI reserved= value
+Controls the amount of space in the realtime section that is reserved for
+internal use by garbage collection and reorganization algorithms.
+Defaults 0 if not set.
+This option is only valid if the zoned realtime allocator is used.
 .RE
 .PP
 .PD 0