From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Tue, 3 Jan 2023 12:30:14 +0000 (+0900)
Subject: doc: Update nvme sanitize command action description
X-Git-Tag: v2.3~25^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=f9d35bf0611ff447a2d29d3223491e2fca8a6b86;p=users%2Fsagi%2Fnvme-cli.git

doc: Update nvme sanitize command action description

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

diff --git a/Documentation/nvme-sanitize.txt b/Documentation/nvme-sanitize.txt
index df76c26b..c3b9af22 100644
--- a/Documentation/nvme-sanitize.txt
+++ b/Documentation/nvme-sanitize.txt
@@ -70,10 +70,10 @@ OPTIONS
 |=================
 |Value|Definition
 |0x00| Reserved
-|0x01| Exit Failure Mode
-|0x02| Start a Block Erase sanitize operation
-|0x03| Start an Overwrite sanitize operation
-|0x04| Start a Crypto Erase sanitize operation
+|0x01 \| 'exit-failure'| Exit Failure Mode
+|0x02 \| 'start-block-erase'| Start a Block Erase sanitize operation
+|0x03 \| 'start-overwrite'| Start an Overwrite sanitize operation
+|0x04 \| 'start-crypto-erase'| Start a Crypto Erase sanitize operation
 |=================
 
 -p <overwrite-pattern>::
@@ -95,6 +95,7 @@ EXAMPLES
 ------------
 # nvme sanitize /dev/nvme0 -a 0x02
 # nvme sanitize /dev/nvme0 --sanact=0x01
+# nvme sanitize /dev/nvme0 --sanact=start-overwrite
 
 ------------