From b8210b1af6dd369a577b2ea2c2fa0f25bffaa3f4 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sat, 20 Nov 2021 08:04:39 +0100
Subject: Merging upstream version 1.16.

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

(limited to 'Documentation/nvme-boot-part-log.txt')

diff --git a/Documentation/nvme-boot-part-log.txt b/Documentation/nvme-boot-part-log.txt
new file mode 100644
index 0000000..2dd32a6
--- /dev/null
+++ b/Documentation/nvme-boot-part-log.txt
@@ -0,0 +1,51 @@
+nvme-boot-part-log(1)
+=====================
+
+NAME
+----
+nvme-boot-part-log - Retrieves a Boot Partition log page from an NVMe device
+
+SYNOPSIS
+--------
+[verse]
+'nvme boot-part-log' <device> [--lsp=<field> | -s <field>]
+                    [--output-file=<file> | -o <file>]
+                    [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+Retrieves an Boot Partition log page from an NVMe device and provides
+the returned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the returned log structure will be in raw binary format _only_ with
+--output-file option which is mandatory.
+
+OPTIONS
+-------
+-s <field>::
+--lsp=<field>::
+	The log specified field of LID.
+
+-o <file>::
+--output-file=<file>::
+	File name to which raw binary data will be saved to.
+
+-o <format>::
+--output-format=<format>::
+    Set the reporting format to 'normal', 'json', or
+    'binary'. Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Retrieve Boot Partition data to boot_part_log.bin
++
+------------
+# nvme boot-part-log /dev/nvme0 --output-file=boot_part_log.bin
+------------
+
+NVME
+----
+Part of the nvme-user suite
-- 
cgit v1.2.3