From: Daniel Wagner <dwagner@suse.de>
Date: Wed, 26 Oct 2022 12:41:19 +0000 (+0200)
Subject: doc: Add nvme show-topology documnetation
X-Git-Tag: v2.2~12^2~1
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=bc50ee7d4b745a78a752763b1c5e08ae718bc307;p=users%2Fsagi%2Fnvme-cli.git

doc: Add nvme show-topology documnetation

Signed-off-by: Daniel Wagner <dwagner@suse.de>
---

diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt
index 58a8094f..14a6ff69 100644
--- a/Documentation/cmds-main.txt
+++ b/Documentation/cmds-main.txt
@@ -270,3 +270,6 @@ linknvme:nvme-supported-log-pages[1]::
 
 linknvme:nvme-verify[1]::
 	verify command
+
+linknvme:nvme-show-topology[1]::
+	Show NVMe topology
diff --git a/Documentation/meson.build b/Documentation/meson.build
index 08841a0f..bb0c9724 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -113,6 +113,7 @@ adoc_sources = [
   'nvme-set-property',
   'nvme-show-hostnqn',
   'nvme-show-regs',
+  'nvme-show-topology',
   'nvme-smart-log',
   'nvme-subsystem-reset',
   'nvme-supported-log-pages',
diff --git a/Documentation/nvme-show-topology.txt b/Documentation/nvme-show-topology.txt
new file mode 100644
index 00000000..f0583fbc
--- /dev/null
+++ b/Documentation/nvme-show-topology.txt
@@ -0,0 +1,42 @@
+nvme-show-topology(1)
+=====================
+
+NAME
+----
+nvme-show-topology - Show topology of all NVMe subsystems
+
+SYNOPSIS
+--------
+[verse]
+'nvme show-topology'
+
+DESCRIPTION
+-----------
+Show the topology of all NVMe subsystems.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+	Set the reporting format to 'normal' or 'json'. Only one output
+	format can be used at a time.
+
+-v::
+--verbose::
+	Increase the information in the output, showing nvme subsystems,
+	controllers and namespaces separately and how they're related to each
+	other.
+
+-r <order>::
+--ranking=<order>::
+	Set the ranking orer to 'namespace' (default) or 'ctrl'. This option
+	has only an effect for output format 'normal'. The JSON output is
+	always 'namespace' ordered.
+
+EXAMPLES
+--------
+nvme show-topology
+
+NVME
+----
+Part of the nvme-user suite