[PATCH] xfs_io: document zero and help commands in manpage

[PATCH] xfs_io: document zero and help commands in manpage

[Eric Sandeen]

zero & fzero are 2 different commands using 2 different interfaces
to do the same thing, but may as well document them both.

Also explicitly document "help" to be consistent, and to satisfy
the xfstest which checks for all commands being documented.

Signed-off-by: Eric Sandeen <sandeen@redhat.com>
---


diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
index 7fd7478..33fbe6a 100644
--- a/man/man8/xfs_io.8
+++ b/man/man8/xfs_io.8
@@ -420,6 +420,13 @@ Call fallocate with FALLOC_FL_ZERO_RANGE flag as described in the
 .BR fallocate (2)
 manual page to allocate and zero blocks within the range.
 .TP
+.BI zero " offset length"
+Call xfsctl with
+.B XFS_IOC_ZERO_RANGE
+as described in the
+.BR xfsctl (3)
+manual page to allocate and zero blocks within the range.
+.TP
 .BI truncate " offset"
 Truncates the current file at the given offset using
 .BR ftruncate (2).
@@ -681,6 +688,9 @@ for the current memory mapping.
 
 .SH OTHER COMMANDS
 .TP
+.BR "help [ " command " ]"
+Display a brief description of one or all commands.
+.TP
 .B print
 Display a list of all open files and memory mapped regions.
 The current file and current mapping are distinguishable from


_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs

Re: [PATCH] xfs_io: document zero and help commands in manpage

[Brian Foster]

On Fri, Dec 04, 2015 at 03:58:08PM -0600, Eric Sandeen wrote:
> zero & fzero are 2 different commands using 2 different interfaces
> to do the same thing, but may as well document them both.
> 
> Also explicitly document "help" to be consistent, and to satisfy
> the xfstest which checks for all commands being documented.
> 
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> ---

Reviewed-by: Brian Foster <bfoster@redhat.com>

> 
> 
> diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
> index 7fd7478..33fbe6a 100644
> --- a/man/man8/xfs_io.8
> +++ b/man/man8/xfs_io.8
> @@ -420,6 +420,13 @@ Call fallocate with FALLOC_FL_ZERO_RANGE flag as described in the
>  .BR fallocate (2)
>  manual page to allocate and zero blocks within the range.
>  .TP
> +.BI zero " offset length"
> +Call xfsctl with
> +.B XFS_IOC_ZERO_RANGE
> +as described in the
> +.BR xfsctl (3)
> +manual page to allocate and zero blocks within the range.
> +.TP
>  .BI truncate " offset"
>  Truncates the current file at the given offset using
>  .BR ftruncate (2).
> @@ -681,6 +688,9 @@ for the current memory mapping.
>  
>  .SH OTHER COMMANDS
>  .TP
> +.BR "help [ " command " ]"
> +Display a brief description of one or all commands.
> +.TP
>  .B print
>  Display a list of all open files and memory mapped regions.
>  The current file and current mapping are distinguishable from
> 
> 
> _______________________________________________
> xfs mailing list
> xfs@oss.sgi.com
> http://oss.sgi.com/mailman/listinfo/xfs

_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs