Skip to contentSkip to conversation

xfs_io: document zero and help commands in manpage

PATCH In review Eric Sandeen 2 participants 2 messages Dec 4, 2015 – Dec 7, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 xfs_io: document zero and help commands in manpage

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.

---

man/man8/xfs_io.8 +10 -0
index 7fd7478..33fbe6a 100644
@@ -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
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · 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.

---

Quoted 32 lines
man/man8/xfs_io.8 +10 -0
index 7fd7478..33fbe6a 100644
@@ -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
Quoted 4 lines

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs

_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs