From db2181adeeffa517ec5a40be93a70e5ac4d7a34c Mon Sep 17 00:00:00 2001 From: Minwoo Im Date: Sun, 7 Apr 2019 06:12:29 +0900 Subject: [PATCH] doc: Update show-regs document with output-format Previous commit has introduced --output-format argument for show-regs subcommand so that document should be updated. Signed-off-by: Minwoo Im --- Documentation/nvme-show-regs.1 | 42 ++++++++++++++++++++++++++----- Documentation/nvme-show-regs.html | 41 ++++++++++++++++++++++++------ Documentation/nvme-show-regs.txt | 15 +++++++++-- 3 files changed, 83 insertions(+), 15 deletions(-) diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1 index a48eb5c..fabdb24 100644 --- a/Documentation/nvme-show-regs.1 +++ b/Documentation/nvme-show-regs.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-id-ns -.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 01/08/2019 +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 04/07/2019 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "01/08/2019" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "04/07/2019" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,8 @@ nvme-show-regs \- Reads and shows the defined NVMe controller registers for NVMe .SH "SYNOPSIS" .sp .nf -\fInvme show\-regs\fR [\-\-human\-readable | \-H] +\fInvme show\-regs\fR [\-\-human\-readable | \-H] + [\-\-output\-format= | \-o ] .fi .SH "DESCRIPTION" .sp @@ -45,6 +46,14 @@ The parameter is mandatory and must be the nvme admin character device .RS 4 Display registers or supported properties in human readable format\&. .RE +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE .SH "EXAMPLES" .sp .RS 4 @@ -61,7 +70,7 @@ Show the NVMe over PCIe controller registers or the NVMe over Fabric controller .RS 4 .\} .nf -# nvme show\-regs /dev/nvme0 +# nvme show\-regs /dev/nvme0 \-o binary .fi .if n \{\ .RE @@ -88,6 +97,27 @@ Show the NVMe over PCIe controller registers or the NVMe over Fabric controller .RE .\} .RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Show the NVMe over PCIe controller registers or NVMe\-oF controller properties in a json format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme show\-regs /dev/nvme0 \-o json +.fi +.if n \{\ +.RE +.\} +.RE .SH "NVME" .sp Part of the nvme\-user suite diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html index 913bba4..1b56c47 100644 --- a/Documentation/nvme-show-regs.html +++ b/Documentation/nvme-show-regs.html @@ -1,9 +1,10 @@ + - + nvme-id-ns(1)