]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Update nvme sanitize command action description
authorTokunori Ikegami <ikegami.t@gmail.com>
Tue, 3 Jan 2023 12:30:14 +0000 (21:30 +0900)
committerTokunori Ikegami <ikegami.t@gmail.com>
Tue, 3 Jan 2023 12:31:28 +0000 (21:31 +0900)
Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
Documentation/nvme-sanitize.txt

index df76c26beb0d898dfd34f7a9b9e0a65f5eb59d80..c3b9af22c7d0a8655f807551dea47e40eadd2e8b 100644 (file)
@@ -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
 
 ------------