[PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[Hans Holmberg]

Remove the duplicated section and while at it, turn spaces into tabs.

Signed-off-by: Hans Holmberg <hans.holmberg@wdc.com>
---

This fixes up the warning reported by Stephen Rothwell for linux-next

 Documentation/admin-guide/xfs.rst | 29 ++++++++---------------------
 1 file changed, 8 insertions(+), 21 deletions(-)

diff --git a/Documentation/admin-guide/xfs.rst b/Documentation/admin-guide/xfs.rst
index 3e76276bd488..5becb441c3cb 100644
--- a/Documentation/admin-guide/xfs.rst
+++ b/Documentation/admin-guide/xfs.rst
@@ -562,7 +562,7 @@ The interesting knobs for XFS workqueues are as follows:
 Zoned Filesystems
 =================
 
-For zoned file systems, the following attribute is exposed in:
+For zoned file systems, the following attributes are exposed in:
 
   /sys/fs/xfs/<dev>/zoned/
 
@@ -572,23 +572,10 @@ For zoned file systems, the following attribute is exposed in:
 	is limited by the capabilities of the backing zoned device, file system
 	size and the max_open_zones mount option.
 
-Zoned Filesystems
-=================
-
-For zoned file systems, the following attributes are exposed in:
-
- /sys/fs/xfs/<dev>/zoned/
-
- max_open_zones                 (Min:  1  Default:  Varies  Max:  UINTMAX)
-        This read-only attribute exposes the maximum number of open zones
-        available for data placement. The value is determined at mount time and
-        is limited by the capabilities of the backing zoned device, file system
-        size and the max_open_zones mount option.
-
- zonegc_low_space               (Min:  0  Default:  0  Max:  100)
-        Define a percentage for how much of the unused space that GC should keep
-        available for writing. A high value will reclaim more of the space
-        occupied by unused blocks, creating a larger buffer against write
-        bursts at the cost of increased write amplification.  Regardless
-        of this value, garbage collection will always aim to free a minimum
-        amount of blocks to keep max_open_zones open for data placement purposes.
+  zonegc_low_space		(Min:  0  Default:  0  Max:  100)
+	Define a percentage for how much of the unused space that GC should keep
+	available for writing. A high value will reclaim more of the space
+	occupied by unused blocks, creating a larger buffer against write
+	bursts at the cost of increased write amplification.  Regardless
+	of this value, garbage collection will always aim to free a minimum
+	amount of blocks to keep max_open_zones open for data placement purposes.
-- 
2.34.1

Re: [PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[Carlos Maiolino]

On Tue, Apr 22, 2025 at 11:50:07AM +0000, Hans Holmberg wrote:
> Remove the duplicated section and while at it, turn spaces into tabs.
> 
> Signed-off-by: Hans Holmberg <hans.holmberg@wdc.com>

Sounds good.

Reviewed-by: Carlos Maiolino <cmaiolino@redhat.com>

Hans, I'm adding a Fixes tag before merging if you don't mind me editing the
patch before applying.

Fixes: c7b67ddc3c9 ("xfs: document zoned rt specifics in admin-guide")


> ---
> 
> This fixes up the warning reported by Stephen Rothwell for linux-next
> 
>  Documentation/admin-guide/xfs.rst | 29 ++++++++---------------------
>  1 file changed, 8 insertions(+), 21 deletions(-)
> 
> diff --git a/Documentation/admin-guide/xfs.rst b/Documentation/admin-guide/xfs.rst
> index 3e76276bd488..5becb441c3cb 100644
> --- a/Documentation/admin-guide/xfs.rst
> +++ b/Documentation/admin-guide/xfs.rst
> @@ -562,7 +562,7 @@ The interesting knobs for XFS workqueues are as follows:
>  Zoned Filesystems
>  =================
> 
> -For zoned file systems, the following attribute is exposed in:
> +For zoned file systems, the following attributes are exposed in:
> 
>    /sys/fs/xfs/<dev>/zoned/
> 
> @@ -572,23 +572,10 @@ For zoned file systems, the following attribute is exposed in:
>  	is limited by the capabilities of the backing zoned device, file system
>  	size and the max_open_zones mount option.
> 
> -Zoned Filesystems
> -=================
> -
> -For zoned file systems, the following attributes are exposed in:
> -
> - /sys/fs/xfs/<dev>/zoned/
> -
> - max_open_zones                 (Min:  1  Default:  Varies  Max:  UINTMAX)
> -        This read-only attribute exposes the maximum number of open zones
> -        available for data placement. The value is determined at mount time and
> -        is limited by the capabilities of the backing zoned device, file system
> -        size and the max_open_zones mount option.
> -
> - zonegc_low_space               (Min:  0  Default:  0  Max:  100)
> -        Define a percentage for how much of the unused space that GC should keep
> -        available for writing. A high value will reclaim more of the space
> -        occupied by unused blocks, creating a larger buffer against write
> -        bursts at the cost of increased write amplification.  Regardless
> -        of this value, garbage collection will always aim to free a minimum
> -        amount of blocks to keep max_open_zones open for data placement purposes.
> +  zonegc_low_space		(Min:  0  Default:  0  Max:  100)
> +	Define a percentage for how much of the unused space that GC should keep
> +	available for writing. A high value will reclaim more of the space
> +	occupied by unused blocks, creating a larger buffer against write
> +	bursts at the cost of increased write amplification.  Regardless
> +	of this value, garbage collection will always aim to free a minimum
> +	amount of blocks to keep max_open_zones open for data placement purposes.
> --
> 2.34.1

Re: [PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[Hans Holmberg]

On 22/04/2025 14:10, Carlos Maiolino wrote:
> On Tue, Apr 22, 2025 at 11:50:07AM +0000, Hans Holmberg wrote:
>> Remove the duplicated section and while at it, turn spaces into tabs.
>>
>> Signed-off-by: Hans Holmberg <hans.holmberg@wdc.com>
> 
> Sounds good.
> 
> Reviewed-by: Carlos Maiolino <cmaiolino@redhat.com>
> 
> Hans, I'm adding a Fixes tag before merging if you don't mind me editing the
> patch before applying.
> 
> Fixes: c7b67ddc3c9 ("xfs: document zoned rt specifics in admin-guide")

Thanks!

> 
> 
>> ---
>>
>> This fixes up the warning reported by Stephen Rothwell for linux-next
>>
>>  Documentation/admin-guide/xfs.rst | 29 ++++++++---------------------
>>  1 file changed, 8 insertions(+), 21 deletions(-)
>>
>> diff --git a/Documentation/admin-guide/xfs.rst b/Documentation/admin-guide/xfs.rst
>> index 3e76276bd488..5becb441c3cb 100644
>> --- a/Documentation/admin-guide/xfs.rst
>> +++ b/Documentation/admin-guide/xfs.rst
>> @@ -562,7 +562,7 @@ The interesting knobs for XFS workqueues are as follows:
>>  Zoned Filesystems
>>  =================
>>
>> -For zoned file systems, the following attribute is exposed in:
>> +For zoned file systems, the following attributes are exposed in:
>>
>>    /sys/fs/xfs/<dev>/zoned/
>>
>> @@ -572,23 +572,10 @@ For zoned file systems, the following attribute is exposed in:
>>  	is limited by the capabilities of the backing zoned device, file system
>>  	size and the max_open_zones mount option.
>>
>> -Zoned Filesystems
>> -=================
>> -
>> -For zoned file systems, the following attributes are exposed in:
>> -
>> - /sys/fs/xfs/<dev>/zoned/
>> -
>> - max_open_zones                 (Min:  1  Default:  Varies  Max:  UINTMAX)
>> -        This read-only attribute exposes the maximum number of open zones
>> -        available for data placement. The value is determined at mount time and
>> -        is limited by the capabilities of the backing zoned device, file system
>> -        size and the max_open_zones mount option.
>> -
>> - zonegc_low_space               (Min:  0  Default:  0  Max:  100)
>> -        Define a percentage for how much of the unused space that GC should keep
>> -        available for writing. A high value will reclaim more of the space
>> -        occupied by unused blocks, creating a larger buffer against write
>> -        bursts at the cost of increased write amplification.  Regardless
>> -        of this value, garbage collection will always aim to free a minimum
>> -        amount of blocks to keep max_open_zones open for data placement purposes.
>> +  zonegc_low_space		(Min:  0  Default:  0  Max:  100)
>> +	Define a percentage for how much of the unused space that GC should keep
>> +	available for writing. A high value will reclaim more of the space
>> +	occupied by unused blocks, creating a larger buffer against write
>> +	bursts at the cost of increased write amplification.  Regardless
>> +	of this value, garbage collection will always aim to free a minimum
>> +	amount of blocks to keep max_open_zones open for data placement purposes.
>> --
>> 2.34.1
> 

Re: [PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[hch]

Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>

Re: [PATCH] xfs: remove duplicate Zoned Filesystems sections in admin-guide

[Carlos Maiolino]

On Tue, 22 Apr 2025 11:50:07 +0000, Hans Holmberg wrote:
> Remove the duplicated section and while at it, turn spaces into tabs.
> 
> 

Applied to for-next, thanks!

[1/1] xfs: remove duplicate Zoned Filesystems sections in admin-guide
      commit: f0447f80aec83f1699d599c94618bb5c323963e6

Best regards,
-- 
Carlos Maiolino <cem@kernel.org>