]> www.infradead.org Git - users/sagi/nvme-cli.git/commit
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)
commitd7555953673bf340b076a00f23166d070b6b7bf6
tree8157fe2a3fe88ad2001ea7e87b22c760da89e1ff
parent6c186de13316d9de4d19f4e7023c8c78cb15c5ac
doc: Fix sanitize command examples as character device

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