* [PATCH] xfsprogs: fix ioctl_xfs_geometry manpage naming
@ 2020-10-06 14:22 Eric Sandeen
2020-10-06 15:25 ` [PATCH V2] " Eric Sandeen
0 siblings, 1 reply; 3+ messages in thread
From: Eric Sandeen @ 2020-10-06 14:22 UTC (permalink / raw)
To: xfs; +Cc: Darrick J. Wong
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@redhat.com>
---
Note the file rename below
Do we need to install symlink from the old name or can we just wing this one
and let "apropos" et al find it ...
diff --git a/man/man2/ioctl_xfs_fsop_geometry.2 b/man/man2/ioctl_xfs_geometry.2
similarity index 95%
rename from man/man2/ioctl_xfs_fsop_geometry.2
rename to man/man2/ioctl_xfs_geometry.2
index a35bbaeb..d4fcef6d 100644
--- a/man/man2/ioctl_xfs_fsop_geometry.2
+++ b/man/man2/ioctl_xfs_geometry.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-GEOMETRY 2 2019-06-17 "XFS"
.SH NAME
-ioctl_xfs_fsop_geometry \- report XFS filesystem layout and features
+ioctl_xfs_geometry \- 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..d7635329 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_geometry (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_geometry (2),
.BR ioctl_xfs_fsbulkstat (2),
.BR ioctl_xfs_scrub_metadata (2),
.BR ioctl_xfs_fsinumbers (2),
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH V2] xfsprogs: fix ioctl_xfs_geometry manpage naming
2020-10-06 14:22 [PATCH] xfsprogs: fix ioctl_xfs_geometry manpage naming Eric Sandeen
@ 2020-10-06 15:25 ` Eric Sandeen
2020-10-06 15:32 ` Darrick J. Wong
0 siblings, 1 reply; 3+ messages in thread
From: Eric Sandeen @ 2020-10-06 15:25 UTC (permalink / raw)
To: xfs; +Cc: Darrick J. Wong
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@redhat.com>
---
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 ...
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),
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH V2] xfsprogs: fix ioctl_xfs_geometry manpage naming
2020-10-06 15:25 ` [PATCH V2] " Eric Sandeen
@ 2020-10-06 15:32 ` Darrick J. Wong
0 siblings, 0 replies; 3+ messages in thread
From: Darrick J. Wong @ 2020-10-06 15:32 UTC (permalink / raw)
To: Eric Sandeen; +Cc: xfs
> 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@redhat.com>
> ---
>
> 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@oracle.com>
--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),
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-10-06 15:34 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-06 14:22 [PATCH] xfsprogs: fix ioctl_xfs_geometry manpage naming Eric Sandeen
2020-10-06 15:25 ` [PATCH V2] " Eric Sandeen
2020-10-06 15:32 ` Darrick J. Wong
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).