docs: documentation for sg WRITE STREAM(16)

Signed-off-by: Vincent Fu <vincent.fu@samsung.com>
Link: https://lore.kernel.org/r/20211115200807.117138-7-vincent.fu@samsung.com
Signed-off-by: Jens Axboe <axboe@kernel.dk>

diff --git a/HOWTO b/HOWTO
index 2563bdef24d7de8b679bf06e578688aa2b5a2ff8..f9e7c8572041fee4f95a46ce08cceffc13cb0f94 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -2520,6 +2520,9 @@ with the caveat that when used on the command line, they must come after the
                Buffer (NDOB) bit set. No data will be transferred to the device with
                this bit set. Data written will be a pre-determined pattern such as
                all zeroes.
+       **write_stream**
+               Issue WRITE STREAM(16) commands. Use the **stream_id** option to specify
+               the stream identifier.
        **verify_bytchk_00**
                Issue VERIFY commands with BYTCHK set to 00. This directs the
                device to carry out a medium verification with no data comparison.
@@ -2535,6 +2538,12 @@ with the caveat that when used on the command line, they must come after the
                This is similar to the WRITE SAME command except that data is compared instead
                of written.
 
+.. option:: stream_id=int : [sg]
+
+       Set the stream identifier for WRITE STREAM commands. If this is set to 0 (which is not
+       a valid stream identifier) fio will open a stream and then close it when done. Default
+       is 0.
+
 .. option:: hipri : [sg]
 
        If this option is set, fio will attempt to use polled IO completions.

diff --git a/fio.1 b/fio.1
index 48baebc5020bc00393dd7a3450bffd30c89a1f7c..34aa874d2d4f512ee46ed3dd12cfaedededc46ec 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -2321,6 +2321,10 @@ Buffer (NDOB) bit set. No data will be transferred to the device with
 this bit set. Data written will be a pre-determined pattern such as
 all zeroes.
 .TP
+.B write_stream
+Issue WRITE STREAM(16) commands. Use the stream_id option to specify
+the stream identifier.
+.TP
 .B verify_bytchk_00
 Issue VERIFY commands with BYTCHK set to 00. This directs the device to carry
 out a medium verification with no data comparison.
@@ -2339,6 +2343,11 @@ WRITE SAME command except that data is compared instead of written.
 .RE
 .RE
 .TP
+.BI (sg)stream_id \fR=\fPint
+Set the stream identifier for WRITE STREAM commands. If this is set to 0 (which is not
+a valid stream identifier) fio will open a stream and then close it when done. Default
+is 0.
+.TP
 .BI (nbd)uri \fR=\fPstr
 Specify the NBD URI of the server to test.
 The string is a standard NBD URI (see