]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Update device-self-test command documentation
authorTokunori Ikegami <ikegami.t@gmail.com>
Fri, 27 Jan 2023 21:20:19 +0000 (06:20 +0900)
committerDaniel Wagner <dwagner@suse.de>
Mon, 30 Jan 2023 12:36:12 +0000 (13:36 +0100)
Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
Documentation/nvme-device-self-test.txt
nvme.c

index 48763f5e31a5206ba12a0a7c5b9549be00677279..d09827775939440037811e43397735a6fd3f0b42 100644 (file)
@@ -28,16 +28,19 @@ OPTIONS
 
 -s <NUM>::
 --self-test-code=<NUM>::
-        This field specifies the action taken by the device self-test command : 
+        This field specifies the action taken by the device self-test command :
+         0h: Show current state of device self-test operation
          1h: Start a short device self-test operation
          2h: Start a extended device self-test operation
          eh: Start a vendor specific device self-test operation
-         fh: abort the device self-test operation
+         fh: Abort the device self-test operation
+       Default is 0h.
 
 -w::
 --wait::
        Wait for the device self test to complete before exiting
-
+       The device self-test is aborted by SIGINT signal interrupt for the wait
+       The option is ignored if the abort self-test code option specified.
 
 EXAMPLES
 --------
diff --git a/nvme.c b/nvme.c
index e4f376e50a0c5c8bacf2354e8e0eabdc297062b2..6a51dfe64360b1612dd39ed0168075bc5e5c71bc 100644 (file)
--- a/nvme.c
+++ b/nvme.c
@@ -4265,13 +4265,13 @@ static int device_self_test(int argc, char **argv, struct command *cmd, struct p
                " which provides the necessary log to determine the state of the device";
        const char *namespace_id = "Indicate the namespace in which the device self-test"\
                " has to be carried out";
-       const char * self_test_code = "This field specifies the action taken by the device self-test command : "\
-               "\n0h Show current state of device self-test operation\n"\
-               "\n1h Start a short device self-test operation\n"\
+       const char * self_test_code = "This field specifies the action taken by the device self-test command :\n"\
+               "0h Show current state of device self-test operation\n"\
+               "1h Start a short device self-test operation\n"\
                "2h Start a extended device self-test operation\n"\
                "eh Start a vendor specific device self-test operation\n"\
-               "fh abort the device self-test operation";
-       const char *wait = "wait for the test to finish";
+               "fh Abort the device self-test operation";
+       const char *wait = "Wait for the test to finish";
        struct nvme_dev *dev;
        int err;