aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJiri Pirko <jiri@mellanox.com>2020-04-04 18:16:15 +0200
committerStephen Hemminger <stephen@networkplumber.org>2020-04-06 10:00:32 -0700
commit90ce848b05fc1883ddafcf57af4c7fcbafd85833 (patch)
treee6c49a9a5db50dfa7de706aa35883aa6f6efa82d
parentb37a863cb2d09ad0736334bd6606c05b802c85cf (diff)
downloadiproute2-90ce848b05fc1883ddafcf57af4c7fcbafd85833.tar.gz
devlink: Fix help and man of "devlink health set" command
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>
-rw-r--r--devlink/devlink.c4
-rw-r--r--man/man8/devlink-health.830
2 files changed, 19 insertions, 15 deletions
diff --git a/devlink/devlink.c b/devlink/devlink.c
index ce6e349ed..6a4108108 100644
--- a/devlink/devlink.c
+++ b/devlink/devlink.c
@@ -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)
diff --git a/man/man8/devlink-health.8 b/man/man8/devlink-health.8
index 7ed0ae453..70a86cf0a 100644
--- a/man/man8/devlink-health.8
+++ b/man/man8/devlink-health.8
@@ -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