]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Fix sanitize command examples as character device
authorTokunori Ikegami <ikegami.t@gmail.com>
Thu, 10 Nov 2022 18:02:48 +0000 (03:02 +0900)
committerDaniel Wagner <dwagner@suse.de>
Wed, 16 Nov 2022 08:06:48 +0000 (09:06 +0100)
The documentation for nvme-sanitize provides conflicting statements

Specifically, the documentation says:

    The parameter is mandatory NVMe character device (ex: /dev/nvme0)

However, in the EXAMPLES section, the syntax shown references the Block device:

    nvme sanitize /dev/nvme0n1 --sanact=0x01

Using the characther device is the correct device, thus update the example
accordingly.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
[dwagner: added commit message]
Signed-off-by: Daniel Wagner <dwagner@suse.de>
Documentation/nvme-sanitize.txt

index f98d0399f9ffcf5fc7199ac324523b6eda679295..df76c26beb0d898dfd34f7a9b9e0a65f5eb59d80 100644 (file)
@@ -93,8 +93,8 @@ EXAMPLES
 * Has the program issue Sanitize Command :
 +
 ------------
-# nvme sanitize /dev/nvme0n1 -a 0x02
-# nvme sanitize /dev/nvme0n1 --sanact=0x01
+# nvme sanitize /dev/nvme0 -a 0x02
+# nvme sanitize /dev/nvme0 --sanact=0x01
 
 ------------