aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDouglas Gilbert <dgilbert@interlog.com>2022-03-01 05:20:37 +0000
committerDouglas Gilbert <dgilbert@interlog.com>2022-03-01 05:20:37 +0000
commitd4e94e36b445985f8618ed048c98787ad0edfdf1 (patch)
treebf2b1fa6baa8bc6cbca4da66c3aeadb297f97ba7 /doc
parentc0b22a17517d2e95e66871fd6b94dc76005e619e (diff)
downloadsg3_utils-d4e94e36b445985f8618ed048c98787ad0edfdf1.tar.gz
zoned disk man page improvements
git-svn-id: https://svn.bingwo.ca/repos/sg3_utils/trunk@941 6180dd3e-e324-4e3e-922d-17de1ae2f315
Diffstat (limited to 'doc')
-rw-r--r--doc/sg3_utils.83
-rw-r--r--doc/sg_rep_zones.83
-rw-r--r--doc/sg_reset_wp.816
3 files changed, 17 insertions, 5 deletions
diff --git a/doc/sg3_utils.8 b/doc/sg3_utils.8
index f60fd841..bf81e3ad 100644
--- a/doc/sg3_utils.8
+++ b/doc/sg3_utils.8
@@ -850,3 +850,6 @@ or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
.B sg_decode_sense(sg3_utils), sdparm(sdparm), ddpt(ddpt), lsscsi(lsscsi),
.B dmesg(1), mt(1)
+.br
+The format of this section is: <utility_name>(<package_containing_utility>)
+or <utility_name>(<manpage_section_number_containing_utility>) .
diff --git a/doc/sg_rep_zones.8 b/doc/sg_rep_zones.8
index fe492d1c..0f4c2c4c 100644
--- a/doc/sg_rep_zones.8
+++ b/doc/sg_rep_zones.8
@@ -206,4 +206,5 @@ Copyright \(co 2014\-2022 Douglas Gilbert
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
.SH "SEE ALSO"
-.B sg_reset_wp,sg_zone(sg3_utils)
+.B sg_reset_wp,sg_zone(sg3_utils),
+.B zbd(libzbd), blkzone(util-linux)
diff --git a/doc/sg_reset_wp.8 b/doc/sg_reset_wp.8
index 1627e04c..ecc4ee6b 100644
--- a/doc/sg_reset_wp.8
+++ b/doc/sg_reset_wp.8
@@ -1,4 +1,4 @@
-.TH SG_RESET_WP "8" "May 2018" "sg3_utils\-1.43" SG3_UTILS
+.TH SG_RESET_WP "8" "February 2022" "sg3_utils\-1.48" SG3_UTILS
.SH NAME
sg_reset_wp \- send SCSI RESET WRITE POINTER command
.SH SYNOPSIS
@@ -9,8 +9,8 @@ sg_reset_wp \- send SCSI RESET WRITE POINTER command
.\" Add any additional description here
.PP
Sends a SCSI RESET WRITE POINTER command to the \fIDEVICE\fR. This command
-is found in the soon to be released ZBC standard (draft prior to standard:
-zbc\-r05.pdf).
+is described in ZBC standard (INCITS 536\-2016) and the draft ZBC\-2
+documents at T10 (e.g. zbc2r12.pdf).
.SH OPTIONS
Arguments to long options are mandatory for short options as well.
.TP
@@ -24,6 +24,10 @@ all open zones and full zones. When this option is given then the
ZC is placed in the Zone Count field in the cdb of the RESET WRITE POINTER
command supported by this utility. ZC should be a value from 0 to
65535 (0xffff) inclusive.
+.br
+The action that the \fIDEVICE\fR takes with this option depends on whether
+the \fI\-\-all\fR option is set. See the RESET WRITE POINTER command
+description (e.g. section 5.9, table 46 in zbc2r12.pdf).
.TP
\fB\-h\fR, \fB\-\-help\fR
output the usage message then exit.
@@ -41,6 +45,10 @@ operation on the zone identified by the ZONE ID field. The default value is
0. Either this option or the \fI\-\-all\fR option is required.
\fIID\fR is assumed to be in decimal unless prefixed with '0x' or has a
trailing 'h' which indicate hexadecimal.
+.SH NOTES
+The Zones Emptied log parameter in the Zoned Block Device Statistics log
+page counts the number of times the RESET WRITE POINTER command has
+been (successfully) invoked.
.SH EXIT STATUS
The exit status of sg_reset_wp is 0 when it is successful. Otherwise see
the sg3_utils(8) man page.
@@ -49,7 +57,7 @@ Written by Douglas Gilbert.
.SH "REPORTING BUGS"
Report bugs to <dgilbert at interlog dot com>.
.SH COPYRIGHT
-Copyright \(co 2014\-2018 Douglas Gilbert
+Copyright \(co 2014\-2022 Douglas Gilbert
.br
This software is distributed under a FreeBSD license. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.