[4/9] libxfs: link to the scrub ioctl from xfsctl.3

Commit Message

Darrick J. Wong June 7, 2019, 7:29 p.m. UTC

From: Darrick J. Wong <[e-mail]>

Link to the scrub ioctl documentation from xfsctl.

Signed-off-by: Darrick J. Wong <[e-mail]>
---
 man/man3/xfsctl.3 |    6 ++++++
 1 file changed, 6 insertions(+)

Comments

Eric Sandeen June 17, 2019, 4:19 p.m. UTC | #1

On 6/7/19 2:29 PM, Darrick J. Wong wrote:
> From: Darrick J. Wong <[e-mail]>
> 
> Link to the scrub ioctl documentation from xfsctl.
> 
> Signed-off-by: Darrick J. Wong <[e-mail]>

Seems like every reference to another man page should also be
explicitly in the SEE ALSO section, no?

(there must be a man page best practices manual somewhere, to be
sure i'm not just making stuff up?)

> ---
>  man/man3/xfsctl.3 |    6 ++++++
>  1 file changed, 6 insertions(+)
> 
> 
> diff --git a/man/man3/xfsctl.3 b/man/man3/xfsctl.3
> index 94a6ad4b..cdf0fcfc 100644
> --- a/man/man3/xfsctl.3
> +++ b/man/man3/xfsctl.3
> @@ -411,6 +411,12 @@ See
>  .BR ioctl_xfs_fsbulkstat (2)
>  for more information.
>  
> +.TP
> +.B XFS_IOC_SCRUB_METADATA
> +See
> +.BR ioctl_xfs_scrub_metadata (2)
> +for more information.
> +
>  .PP
>  .nf
>  .B XFS_IOC_THAW
>

Patch

diff --git a/man/man3/xfsctl.3 b/man/man3/xfsctl.3
index 94a6ad4b..cdf0fcfc 100644
--- a/man/man3/xfsctl.3
+++ b/man/man3/xfsctl.3
@@ -411,6 +411,12 @@  See
 .BR ioctl_xfs_fsbulkstat (2)
 for more information.
 
+.TP
+.B XFS_IOC_SCRUB_METADATA
+See
+.BR ioctl_xfs_scrub_metadata (2)
+for more information.
+
 .PP
 .nf
 .B XFS_IOC_THAW