From c4682a0dbc720c867466dc4097a175b1a748704c Mon Sep 17 00:00:00 2001 From: Minwoo Im Date: Thu, 4 Apr 2019 01:25:47 +0900 Subject: [PATCH] doc: Update nvme-connect by describing options Few newly added options have not been described. This patch updates document of nvme-connect. It also makes "See Also" part style proper which have been applied properly as a title. Signed-off-by: Minwoo Im --- Documentation/nvme-connect.1 | 47 +++++++++++++----- Documentation/nvme-connect.html | 86 +++++++++++++++++++++++++++++---- Documentation/nvme-connect.txt | 30 +++++++++++- 3 files changed, 139 insertions(+), 24 deletions(-) diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index 7cb03f47..c607e528 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 01/08/2019 +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" Date: 04/04/2019 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "01/08/2019" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "04/04/2019" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,6 +39,7 @@ nvme-connect \- Connect to a Fabrics controller\&. [\-\-trsvcid= | \-s ] [\-\-host\-traddr= | \-w ] [\-\-hostnqn= | \-q ] + [\-\-hostid= | \-I ] [\-\-nr\-io\-queues=<#> | \-i <#>] [\-\-nr\-write\-queues=<#> | \-W <#>] [\-\-nr\-poll\-queues=<#> | \-P <#>] @@ -46,6 +47,10 @@ nvme-connect \- Connect to a Fabrics controller\&. [\-\-keep\-alive\-tmo=<#> | \-k <#>] [\-\-reconnect\-delay=<#> | \-c <#>] [\-\-ctrl\-loss\-tmo=<#> | \-l <#>] + [\-\-duplicate_connect | \-D] + [\-\-disable_sqflow | \-d] + [\-\-hdr_digest | \-g] + [\-\-data_digest | \-G] .fi .SH "DESCRIPTION" .sp @@ -111,6 +116,11 @@ This field specifies the network address used on the host to connect to the Cont Overrides the default Host NQN that identifies the NVMe Host\&. If this option is not specified, the default is read from /etc/nvme/hostnqn first\&. If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next\&. The Host NQN uniquely identifies the NVMe Host\&. .RE .PP +\-I , \-\-hostid= +.RS 4 +UUID(Universally Unique Identifier) to be discovered which should be formatted\&. +.RE +.PP \-i <#>, \-\-nr\-io\-queues=<#> .RS 4 Overrides the default number of I/O queues create by the driver\&. @@ -145,6 +155,26 @@ Overrides the default delay (in seconds) before reconnect is attempted after a c .RS 4 Overrides the default controller loss timeout period (in seconds)\&. .RE +.PP +\-D, \-\-duplicate_connect +.RS 4 +Allows duplicated connections between same trnsport host and subsystem port\&. +.RE +.PP +\-d, \-\-disable_sqflow +.RS 4 +Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions\&. +.RE +.PP +\-g, \-\-hdr_digest +.RS 4 +Generates/verifies header digest (TCP)\&. +.RE +.PP +\-G, \-\-data_digest +.RS 4 +Generates/verifies data digest (TCP)\&. +.RE .SH "EXAMPLES" .sp .RS 4 @@ -168,16 +198,7 @@ Connect to a subsystem named nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\ .RE .\} .RE -.sp -.if n \{\ -.RS 4 -.\} -.nf -SEE ALSO -.fi -.if n \{\ -.RE -.\} +.SH "SEE ALSO" .sp nvme\-discover(1) nvme\-connect\-all(1) .SH "AUTHORS" diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index 5ac9361b..8e3c6c05 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -1,9 +1,10 @@ + - + nvme-connect(1)