doc: Add virt-mgmt command

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>

diff --git a/Documentation/nvme-virt-mgmt.txt b/Documentation/nvme-virt-mgmt.txt
new file mode 100755 (executable)
index 0000000..5eede14
--- /dev/null
+++ b/Documentation/nvme-virt-mgmt.txt
@@ -0,0 +1,70 @@
+nvme-virt-mgmt(1)
+=================
+
+NAME
+----
+nvme-virt-mgmt - Manage flexible resources between primary and secondary
+controller
+
+SYNOPSIS
+--------
+[verse]
+'nvme virt-mgmt' <device> [--cntlid=<cntlid> | -c <cntlid>]
+                       [--rt=<rt> | -r <rt>] [--act=<act> | -a <act>]
+                       [--nr=<nr> | -n <nr>]
+                       [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Manage flexible resources between primary and secondary controller, return
+results.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-c <cntlid>::
+--cntlid=<cntlid>::
+       Controller identifier (CNTLID)
+
+-r <rt>::
+--rt=<rt>::
+       Resource Type (RT): [0,1]
+       0h: VQ Resources
+       1h: VI Resources
+
+-a <act>::
+--act=<act>::
+       Action(ACT): [1,7,8,9]
+       1h: Primary Flexible
+       7h: Secondary Offline
+       8h: Secondary Assign
+       9h: Secondary Online
+
+-n <nr>::
+--nr=<nr>::
+       Number of controller resources (NR)
+
+-o <fmt>::
+--output-format=<fmt>::
+       Set the reporting format to 'normal', 'json' or 'binary'. Only one
+       output format can be used at a time.
+
+-v::
+--verbose::
+       Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Has the program issue a virt-mgmt to manage flexible resources.
++
+------------
+# nvme virt-mgmt /dev/nvme0 -c 0 -r 1 -a 1 -n 0
+------------
+
+NVME
+----
+Part of the nvme-user suite.

diff --git a/nvme-builtin.h b/nvme-builtin.h
index 9b9a145f0c4f9a14ec5bed6a1ca1cc64c93f985d..2055d0ee5f7cc0f9ab4346fb183eae595267403e 100644 (file)
--- a/nvme-builtin.h
+++ b/nvme-builtin.h
@@ -103,7 +103,7 @@ COMMAND_LIST(
        ENTRY("check-tls-key", "Validate NVMeoF TLS PSK", check_tls_key)
        ENTRY("dir-receive", "Submit a Directive Receive command, return results", dir_receive)
        ENTRY("dir-send", "Submit a Directive Send command, return results", dir_send)
-       ENTRY("virt-mgmt", "Manage Flexible Resources between Primary and Secondary Controller ", virtual_mgmt)
+       ENTRY("virt-mgmt", "Manage Flexible Resources between Primary and Secondary Controller", virtual_mgmt)
        ENTRY("rpmb", "Replay Protection Memory Block commands", rpmb_cmd)
        ENTRY("lockdown", "Submit a Lockdown command,return result", lockdown_cmd)
        ENTRY("dim", "Send Discovery Information Management command to a Discovery Controller", dim_cmd) \