]> git.proxmox.com Git - mirror_iproute2.git/commitdiff
devlink: Fix help and man of "devlink health set" command
authorJiri Pirko <jiri@mellanox.com>
Sat, 4 Apr 2020 16:16:15 +0000 (18:16 +0200)
committerStephen Hemminger <stephen@networkplumber.org>
Mon, 6 Apr 2020 17:00:32 +0000 (10:00 -0700)
Fix the help and man page of "devlink health set" command to be aligned
with the rest of helps and man pages.

Signed-off-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
devlink/devlink.c
man/man8/devlink-health.8

index ce6e349ed2ab96fa2e70821452f55e059e516712..6a41081083d7d5dee96820b4c81d79e89f2c9b84 100644 (file)
@@ -6924,7 +6924,9 @@ static void cmd_health_help(void)
        pr_err("       devlink health diagnose DEV reporter REPORTER_NAME\n");
        pr_err("       devlink health dump show DEV reporter REPORTER_NAME\n");
        pr_err("       devlink health dump clear DEV reporter REPORTER_NAME\n");
-       pr_err("       devlink health set DEV reporter REPORTER_NAME { grace_period | auto_recover } { msec | boolean }\n");
+       pr_err("       devlink health set DEV reporter REPORTER_NAME\n");
+       pr_err("                          [ grace_period MSEC ]\n");
+       pr_err("                          [ auto_recover { true | false } ]\n");
 }
 
 static int cmd_health(struct dl *dl)
index 7ed0ae4534dc04e3c0a1e4f27ad44ff212bfaace..70a86cf0acdc20e6b4b105710c0dad9fa586f60d 100644 (file)
@@ -52,13 +52,13 @@ devlink-health \- devlink health reporting and recovery
 .RI "" DEV ""
 .B reporter
 .RI "" REPORTER ""
-.RI " { "
-.B grace_period | auto_recover
-.RI " } { "
-.RI "" msec ""
-.RI "|"
-.RI "" boolean ""
-.RI " } "
+.RI "[ "
+.BI "grace_period " MSEC "
+.RI "]"
+.RI ""
+.BR auto_recover " { " true " | " false " } "
+.RI "]"
+
 .ti -8
 .B devlink health help
 
@@ -130,15 +130,9 @@ the next "devlink health dump show" command.
 .I "REPORTER"
 - specifies the reporter's name registered on the devlink device.
 
-.SS devlink health set - Enable the user to configure:
-.PD 0
-1) grace_period [msec] - Time interval between consecutive auto recoveries.
-.P
-2) auto_recover [true/false] - Indicates whether the devlink should execute automatic recover on error.
-.P
+.SS devlink health set - Configure health reporter.
 Please note that this command is not supported on a reporter which
 doesn't support a recovery method.
-.PD
 
 .PP
 .I "DEV"
@@ -148,6 +142,14 @@ doesn't support a recovery method.
 .I "REPORTER"
 - specifies the reporter's name registered on the devlink device.
 
+.TP
+.BI grace_period " MSEC "
+Time interval between consecutive auto recoveries.
+
+.TP
+.BR auto_recover " { " true " | " false " } "
+Indicates whether the devlink should execute automatic recover on error.
+
 .SH "EXAMPLES"
 .PP
 devlink health show