Re: [PATCH V2] xfsprogs: fix ioctl_xfs_geometry manpage naming

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



> Subject: [PATCH V2] xfsprogs: fix ioctl_xfs_geometry manpage naming

The subject line should name the old manpage, right?

On Tue, Oct 06, 2020 at 10:25:42AM -0500, Eric Sandeen wrote:
> Somehow "fsop_/FSOP_" snuck into this manpage's name, filename, and
> ioctl name.  It's not XFS_IOC_FSOP_GEOMETRY, it's XFS_IOC_FSGEOMETRY
> so change all references, including the man page name, filename, and
> references from xfsctl(3).
> 
> (the structure and flags do have the fsop_ string, which certainly
> makes this a bit confusing)
> 
> Fixes: b427c816847e ("man: create a separate GEOMETRY ioctl manpage")
> Signed-off-by: Eric Sandeen <sandeen@xxxxxxxxxx>
> ---
> 
> V2: don't rename it to the wrong thing. o_O
> (fsgeometry not geometry)
> 
> Note the file rename below
> 
> Do we need to install link from the old name or can we just wing this one
> and let "apropos" et al find it ...

Up to you; if you decide to leave a breadcrumb, see ioctl_xfs_getbmap.2
for how you're (apparently?) supposed to do that in manpageland.

Reviewed-by: Darrick J. Wong <darrick.wong@xxxxxxxxxx>

--D

> 
> diff --git a/man/man2/ioctl_xfs_fsop_geometry.2 b/man/man2/ioctl_xfs_fsgeometry.2
> similarity index 95%
> rename from man/man2/ioctl_xfs_fsop_geometry.2
> rename to man/man2/ioctl_xfs_fsgeometry.2
> index a35bbaeb..6b7c83da 100644
> --- a/man/man2/ioctl_xfs_fsop_geometry.2
> +++ b/man/man2/ioctl_xfs_fsgeometry.2
> @@ -3,18 +3,18 @@
>  .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
>  .\" SPDX-License-Identifier: GPL-2.0+
>  .\" %%%LICENSE_END
> -.TH IOCTL-XFS-FSOP-GEOMETRY 2 2019-06-17 "XFS"
> +.TH IOCTL-XFS-FSGEOMETRY 2 2019-06-17 "XFS"
>  .SH NAME
> -ioctl_xfs_fsop_geometry \- report XFS filesystem layout and features 
> +ioctl_xfs_fsgeometry \- report XFS filesystem layout and features
>  .SH SYNOPSIS
>  .br
>  .B #include <xfs/xfs_fs.h>
>  .PP
> -.BI "int ioctl(int " fd ", XFS_IOC_FSOP_GEOMETRY, struct xfs_fsop_geom*" arg );
> +.BI "int ioctl(int " fd ", XFS_IOC_FSGEOMETRY, struct xfs_fsop_geom *" arg );
>  .br
> -.BI "int ioctl(int " fd ", XFS_IOC_FSOP_GEOMETRY_V4, struct xfs_fsop_geom_v4 *" arg );
> +.BI "int ioctl(int " fd ", XFS_IOC_FSGEOMETRY_V4, struct xfs_fsop_geom_v4 *" arg );
>  .br
> -.BI "int ioctl(int " fd ", XFS_IOC_FSOP_GEOMETRY_V1, struct xfs_fsop_geom_v1 *" arg );
> +.BI "int ioctl(int " fd ", XFS_IOC_FSGEOMETRY_V1, struct xfs_fsop_geom_v1 *" arg );
>  .SH DESCRIPTION
>  Report the details of an XFS filesystem layout, features, and other descriptive items.
>  This information is conveyed in a structure of the following form:
> diff --git a/man/man3/xfsctl.3 b/man/man3/xfsctl.3
> index dfebd12d..43c2f4eb 100644
> --- a/man/man3/xfsctl.3
> +++ b/man/man3/xfsctl.3
> @@ -333,7 +333,7 @@ for more information.
>  .TP
>  .B XFS_IOC_FSGEOMETRY
>  See
> -.BR ioctl_xfs_fsop_geometry (2)
> +.BR ioctl_xfs_fsgeometry (2)
>  for more information.
>  
>  .TP
> @@ -393,7 +393,7 @@ as they are not of general use to applications.
>  
>  .SH SEE ALSO
>  .BR ioctl_xfs_fsgetxattr (2),
> -.BR ioctl_xfs_fsop_geometry (2),
> +.BR ioctl_xfs_fsgeometry (2),
>  .BR ioctl_xfs_fsbulkstat (2),
>  .BR ioctl_xfs_scrub_metadata (2),
>  .BR ioctl_xfs_fsinumbers (2),
> 



[Index of Archives]     [XFS Filesystem Development (older mail)]     [Linux Filesystem Development]     [Linux Audio Users]     [Yosemite Trails]     [Linux Kernel]     [Linux RAID]     [Linux SCSI]


  Powered by Linux