From mboxrd@z Thu Jan 1 00:00:00 1970 From: jeff.lien@wdc.com (jeffreyalien) Date: Fri, 22 Sep 2017 16:52:27 -0500 Subject: [PATCH 2/2] nvme-cli : Add man documentation files for ns-rescan command. Message-ID: <1506117147-21379-1-git-send-email-jeff.lien@wdc.com> Signed-off-by: jeffreyalien --- Documentation/nvme-ns-rescan.1 | 58 +++++ Documentation/nvme-ns-rescan.html | 455 ++++++++++++++++++++++++++++++++++++++ Documentation/nvme-ns-rescan.txt | 32 +++ 3 files changed, 545 insertions(+) create mode 100644 Documentation/nvme-ns-rescan.1 create mode 100644 Documentation/nvme-ns-rescan.html create mode 100644 Documentation/nvme-ns-rescan.txt diff --git a/Documentation/nvme-ns-rescan.1 b/Documentation/nvme-ns-rescan.1 new file mode 100644 index 0000000..5dc8664 --- /dev/null +++ b/Documentation/nvme-ns-rescan.1 @@ -0,0 +1,58 @@ +'\" t +.\" Title: nvme-ns-rescan +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 09/22/2017 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-NS\-RESCAN" "1" "09/22/2017" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-ns-rescan \- Rescans the nvme namespaces\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme ns\-rescan\fR +.fi +.SH "DESCRIPTION" +.sp +Requests NVMe controller rescans the namespaces\&. The param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Rescans the nvme namespaces\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme ns\-rescan /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-ns-rescan.html b/Documentation/nvme-ns-rescan.html new file mode 100644 index 0000000..20cedb1 --- /dev/null +++ b/Documentation/nvme-ns-rescan.html @@ -0,0 +1,455 @@ + + + + + +nvme-ns-rescan(1) + + + + +

SYNOPSIS

+
+
+
nvme ns-rescan <device>
+
+
+
+

DESCRIPTION

+
+

Requests NVMe controller rescans the namespaces. The <device> param is mandatory and must +be an NVMe character device (ex: /dev/nvme0).

+
+

OPTIONS

+
+

None

+
+

EXAMPLES

+
+
    +
  • +

    +Rescans the nvme namespaces. +

    +
    +
    +
    # nvme ns-rescan /dev/nvme0
    +
    +
    • +
+
+

NVME

+
+

Part of the nvme-user suite

+
+ + + diff --git a/Documentation/nvme-ns-rescan.txt b/Documentation/nvme-ns-rescan.txt new file mode 100644 index 0000000..cd41870 --- /dev/null +++ b/Documentation/nvme-ns-rescan.txt @@ -0,0 +1,32 @@ +nvme-ns-rescan(1) +================= + +NAME +---- +nvme-ns-rescan - Rescans the nvme namespaces. + +SYNOPSIS +-------- +[verse] +'nvme ns-rescan' + +DESCRIPTION +----------- +Requests NVMe controller rescans the namespaces. The param is mandatory and must +be an NVMe character device (ex: /dev/nvme0). + +OPTIONS +------- +None + +EXAMPLES +-------- +* Rescans the nvme namespaces. ++ +------------ +# nvme ns-rescan /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite -- 1.8.3.1