From mboxrd@z Thu Jan 1 00:00:00 1970 From: minwoo.im.dev@gmail.com (Minwoo Im) Date: Wed, 24 Jan 2018 21:25:49 +0900 Subject: [PATCH 2/2] nvme-cli: add documentation for abort command Message-ID: <1516796749-31942-1-git-send-email-minwoo.im.dev@gmail.com> Add documentation for abort command. Signed-off-by: Minwoo Im --- Documentation/cmds-main.txt | 2 + Documentation/nvme-abort.1 | 80 ++++ Documentation/nvme-abort.html | 834 ++++++++++++++++++++++++++++++++++++++++++ Documentation/nvme-abort.txt | 51 +++ 4 files changed, 967 insertions(+) create mode 100644 Documentation/nvme-abort.1 create mode 100644 Documentation/nvme-abort.html create mode 100644 Documentation/nvme-abort.txt diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index 5d5b8f6..0721854 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -112,3 +112,5 @@ linknvme:nvme-discover[1]:: linknvme:nvme-connect[1]:: Connect to an NVMe-over-Fabrics subsystem +linknvme:nvme-abort[1]:: + Abort a specified command diff --git a/Documentation/nvme-abort.1 b/Documentation/nvme-abort.1 new file mode 100644 index 0000000..8938bc2 --- /dev/null +++ b/Documentation/nvme-abort.1 @@ -0,0 +1,80 @@ +'\" t +.\" Title: nvme-abort +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 01/24/2018 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-ABORT" "1" "01/24/2018" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-abort \- Used to abort a specified command\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme abort\fR [\-\-sqid= | \-s ] + [\-\-cid= | \-c ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send an NVMe Abort admin command and provides the results\&. +.sp +The Abort command is used to abort a specific command previously submitted to the Admin Submission Queue or an I/O Submission Queue\&. An Abort command is a best effort command; the command to be aborted may have already completed, currently be in execution, or be deeply queued\&. +.sp +The Abort Command Limit(ACL) field in Identify Controller indicates the controller limit on concurrent execution of Abort commands\&. If host submits the number of outstanding Abort commands to exceed this value, "Abort Command Limit Exceeded" status will be returned\&. +.SH "OPTIONS" +.PP +\-s , \-\-sqid= +.RS 4 +Specifies the identifier of the Submission Queue that the command to be aborted is associated with\&. +.RE +.PP +\-c , \-\-cid= +.RS 4 +Specifies the command identifier of the command to be aborted, that was specified in the CDW10\&.CID field within the command itself\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Abort a I/O command whose CID is 0x20 in #1 SQ: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme abort /dev/nvme0 \-\-sqid=1 \-\-cid=0x20 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-abort.html b/Documentation/nvme-abort.html new file mode 100644 index 0000000..4fc9a79 --- /dev/null +++ b/Documentation/nvme-abort.html @@ -0,0 +1,834 @@ + + + + + +nvme-abort(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme abort <device> [--sqid=<sqid> | -s <sqid>]
+                    [--cid=<cid> | -c <cid>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send an NVMe Abort admin command and provides +the results.

+

The Abort command is used to abort a specific command previously submitted to +the Admin Submission Queue or an I/O Submission Queue. An Abort command is a +best effort command; the command to be aborted may have already completed, +currently be in execution, or be deeply queued.

+

The Abort Command Limit(ACL) field in Identify Controller indicates the +controller limit on concurrent execution of Abort commands. If host submits +the number of outstanding Abort commands to exceed this value, "Abort Command +Limit Exceeded" status will be returned.

+
+
+
+

OPTIONS

+
+
+
+-s <sqid> +
+
+--sqid=<sqid> +
+
+

+ Specifies the identifier of the Submission Queue that the command to + be aborted is associated with. +

+
+
+-c <cid> +
+
+--cid=<cid> +
+
+

+ Specifies the command identifier of the command to be aborted, that was + specified in the CDW10.CID field within the command itself. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Abort a I/O command whose CID is 0x20 in #1 SQ: +

    +
    +
    +
    # nvme abort /dev/nvme0 --sqid=1 --cid=0x20
    +
    +
  • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+

+ + + diff --git a/Documentation/nvme-abort.txt b/Documentation/nvme-abort.txt new file mode 100644 index 0000000..10b1308 --- /dev/null +++ b/Documentation/nvme-abort.txt @@ -0,0 +1,51 @@ +nvme-abort(1) +============= + +NAME +---- +nvme-abort - Used to abort a specified command. + +SYNOPSIS +-------- +[verse] +'nvme abort' [--sqid= | -s ] + [--cid= | -c ] + +DESCRIPTION +----------- +For the NVMe device given, send an NVMe Abort admin command and provides +the results. + +The Abort command is used to abort a specific command previously submitted to +the Admin Submission Queue or an I/O Submission Queue. An Abort command is a +best effort command; the command to be aborted may have already completed, +currently be in execution, or be deeply queued. + +The Abort Command Limit(ACL) field in Identify Controller indicates the +controller limit on concurrent execution of Abort commands. If host submits +the number of outstanding Abort commands to exceed this value, "Abort Command +Limit Exceeded" status will be returned. + +OPTIONS +------- +-s :: +--sqid=:: + Specifies the identifier of the Submission Queue that the command to + be aborted is associated with. + +-c :: +--cid=:: + Specifies the command identifier of the command to be aborted, that was + specified in the CDW10.CID field within the command itself. + +EXAMPLES +-------- +* Abort a I/O command whose CID is 0x20 in #1 SQ: ++ +------------ +# nvme abort /dev/nvme0 --sqid=1 --cid=0x20 +------------ + +NVME +---- +Part of the nvme-user suite -- 2.7.4