From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Wed, 10 Apr 2024 21:41:32 +0200
Subject: Adding upstream version 2.8.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 Documentation/nvme-list-ctrl.txt | 57 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 Documentation/nvme-list-ctrl.txt

(limited to 'Documentation/nvme-list-ctrl.txt')

diff --git a/Documentation/nvme-list-ctrl.txt b/Documentation/nvme-list-ctrl.txt
new file mode 100644
index 0000000..6cd5c01
--- /dev/null
+++ b/Documentation/nvme-list-ctrl.txt
@@ -0,0 +1,57 @@
+nvme-list-ctrl(1)
+=================
+
+NAME
+----
+nvme-list-ctrl - Send NVMe Identify List Controllers, return result and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme list-ctrl' <device> [--cntid=<cntid> | -c <cntid>]
+			[--namespace-id=<nsid> | -n <nsid>]
+			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends an identify command for controller list
+and provides the result and returned structure. This uses either mode
+12h or 13h depending on the requested namespace identifier.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+The starting controller in the list always begins with 0 unless the
+`'--cntid'` option is given to override.
+
+On success, the controller array is printed for each index and controller
+identifier.
+
+OPTIONS
+-------
+-c <cntid>::
+--cntid=<cntid>::
+	Retrieve the identify list structure starting with the given controller id.
+
+-n <nsid>::
+--namespace-id=<nsid>::
+	If provided, will request the controllers attached to the
+	specified namespace. If no namespace is given, or set to 0, the
+	command requests the controller list for the entire subsystem,
+	whether or not they are attached to namespace(s).
+
+-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
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite
-- 
cgit v1.2.3