diff mbox series

[2/4] mkfs.xfs(8): remove incorrect default inode allocator description

Message ID 1639167697-15392-3-git-send-email-sandeen@sandeen.net (mailing list archive)
State Deferred, archived
Headers show
Series xfsprogs: misc small fixes | expand

Commit Message

Eric Sandeen Dec. 10, 2021, 8:21 p.m. UTC
From: Eric Sandeen <sandeen@redhat.com>

The "maxpct" section of the mkfs.xfs manpage has a gratuitous and
incorrect description of the default inode allocator mode.

inode64 has been the default since 2012, as of

08bf540412ed xfs: make inode64 as the default allocation mode

so the description is wrong. In addition, imaxpct is only
tangentially related to inode allocator behavior, so this section
of the man page is really the wrong place for discussion.

Signed-off-by: Eric Sandeen <sandeen@redhat.com>
Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
---
 man/man8/mkfs.xfs.8 | 19 ++++++-------------
 1 file changed, 6 insertions(+), 13 deletions(-)

Comments

Darrick J. Wong Dec. 11, 2021, 12:19 a.m. UTC | #1
On Fri, Dec 10, 2021 at 02:21:35PM -0600, Eric Sandeen wrote:
> From: Eric Sandeen <sandeen@redhat.com>
> 
> The "maxpct" section of the mkfs.xfs manpage has a gratuitous and
> incorrect description of the default inode allocator mode.
> 
> inode64 has been the default since 2012, as of
> 
> 08bf540412ed xfs: make inode64 as the default allocation mode
> 
> so the description is wrong. In addition, imaxpct is only
> tangentially related to inode allocator behavior, so this section
> of the man page is really the wrong place for discussion.
> 
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> Signed-off-by: Eric Sandeen <sandeen@sandeen.net>

Looks ok,
Reviewed-by: Darrick J. Wong <djwong@kernel.org>

--D

> ---
>  man/man8/mkfs.xfs.8 | 19 ++++++-------------
>  1 file changed, 6 insertions(+), 13 deletions(-)
> 
> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> index a7f7028..a67532a 100644
> --- a/man/man8/mkfs.xfs.8
> +++ b/man/man8/mkfs.xfs.8
> @@ -568,22 +568,15 @@ can be allocated to inodes. The default
>  is 25% for filesystems under 1TB, 5% for filesystems under 50TB and 1%
>  for filesystems over 50TB.
>  .IP
> -In the default inode allocation mode, inode blocks are chosen such
> -that inode numbers will not exceed 32 bits, which restricts the inode
> -blocks to the lower portion of the filesystem. The data block
> -allocator will avoid these low blocks to accommodate the specified
> -maxpct, so a high value may result in a filesystem with nothing but
> -inodes in a significant portion of the lower blocks of the filesystem.
> -(This restriction is not present when the filesystem is mounted with
> -the
> -.I "inode64"
> -option on 64-bit platforms).
> -.IP
>  Setting the value to 0 means that essentially all of the filesystem
> -can become inode blocks, subject to inode32 restrictions.
> +can become inode blocks (subject to possible
> +.B inode32
> +mount option restrictions, see
> +.BR xfs (5)
> +for details.)
>  .IP
>  This value can be modified with
> -.IR xfs_growfs(8) .
> +.BR xfs_growfs (8).
>  .TP
>  .BI align[= value ]
>  This is used to specify that inode allocation is or is not aligned. The
> -- 
> 1.8.3.1
>
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index a7f7028..a67532a 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -568,22 +568,15 @@  can be allocated to inodes. The default
 is 25% for filesystems under 1TB, 5% for filesystems under 50TB and 1%
 for filesystems over 50TB.
 .IP
-In the default inode allocation mode, inode blocks are chosen such
-that inode numbers will not exceed 32 bits, which restricts the inode
-blocks to the lower portion of the filesystem. The data block
-allocator will avoid these low blocks to accommodate the specified
-maxpct, so a high value may result in a filesystem with nothing but
-inodes in a significant portion of the lower blocks of the filesystem.
-(This restriction is not present when the filesystem is mounted with
-the
-.I "inode64"
-option on 64-bit platforms).
-.IP
 Setting the value to 0 means that essentially all of the filesystem
-can become inode blocks, subject to inode32 restrictions.
+can become inode blocks (subject to possible
+.B inode32
+mount option restrictions, see
+.BR xfs (5)
+for details.)
 .IP
 This value can be modified with
-.IR xfs_growfs(8) .
+.BR xfs_growfs (8).
 .TP
 .BI align[= value ]
 This is used to specify that inode allocation is or is not aligned. The