From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 21:41:32 +0200 Subject: Adding upstream version 2.8. Signed-off-by: Daniel Baumann --- Documentation/nvme-wdc-vs-device-waf.txt | 53 ++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 Documentation/nvme-wdc-vs-device-waf.txt (limited to 'Documentation/nvme-wdc-vs-device-waf.txt') diff --git a/Documentation/nvme-wdc-vs-device-waf.txt b/Documentation/nvme-wdc-vs-device-waf.txt new file mode 100644 index 0000000..f25618d --- /dev/null +++ b/Documentation/nvme-wdc-vs-device-waf.txt @@ -0,0 +1,53 @@ +nvme-wdc-vs-device-waf(1) +========================= + +NAME +---- +nvme-wdc-vs-device-waf - Calculates the device write amplification factor and +prints both TLC and SLC results + +SYNOPSIS +-------- +[verse] +'nvme wdc vs-device-waf' [--output-format= -o ] + [--namespace-id= | -n ] + +DESCRIPTION +----------- +For the NVMe device given, calculates the device TLC and SLC write +amplification factor. + +The parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal', or + 'json'. Only one output format can be used at a time. + Default is normal. + +-n :: +--namespace-id=:: + Sets the command's nsid value to the given nsid. Defaults to + 0xffffffff if not given. This option may not affect anything + depending on the log page, which may or may not be specific to + a namespace. + +EXAMPLES +-------- +* Has the program issue WDC vs-device-waf plugin Command : ++ +------------ +# nvme wdc vs-device-waf /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. -- cgit v1.2.3