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 58a8094fcd0bf41d520801b2ffc18c9ab87ca61d..14a6ff69984a771085d23874e5e3c97ec5ee4f95 100644 (file)
--- 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 08841a0fff27aa03ef67e62b2c45a3fbc06996af..bb0c97244602e6e0a20bd18a94e8c2cec0d2851d 100644 (file)
--- 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 (file)
index 0000000..f0583fb
--- /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