]> 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:35 +0000 (09:06 +0100)
commite046862d6ca961b7b2c32831b0f8c144bf302a73
treef48684eb322d16213d27bdb8bb6f081f6a80a6d7
parent7a20585eda7cb2600fe5a730d088cef239343680
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