Skip to contentSkip to conversation

nvme-cli : Add man documentation files for ns-rescan command.

PATCH New jeffreyalien 2 participants 2 messages Sep 22, 2017

Subsystems (2)
Documentation NVMe
lore
Share & tools
lore

jeffreyalien

author
#0 lore raw

PATCH 2/2 nvme-cli : Add man documentation files for ns-rescan command.

Signed-off-by jeffreyalien <jeff.lien at wdc.com>
---
 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
Documentation/nvme-ns-rescan.1 new file +58 -0
new file mode 100644
index 0000000..5dc8664
@@ -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 <http://docbook.sf.net/>
+.\"      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 <device>
+.fi
+.SH "DESCRIPTION"
+.sp
+Requests NVMe controller rescans the namespaces\&. The <device> 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
Documentation/nvme-ns-rescan.html new file +455 -0

455 lines not on this page · raw message

Documentation/nvme-ns-rescan.txt new file +32 -0
new file mode 100644
index 0000000..cd41870
@@ -0,0 +1,32 @@
+nvme-ns-rescan(1)
+=================
+
+NAME
+----
+nvme-ns-rescan - Rescans the nvme namespaces.
+
+SYNOPSIS
+--------
+[verse]
+'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
Signature · 1 line
1.8.3.1
Applied
#1 lore raw

PATCH 2/2 nvme-cli : Add man documentation files for ns-rescan command.

Applied, thanks.