[iproute2-next,v2,3/3] devlink : update man page for new commands

Commit Message

Vikas Gupta July 7, 2022, 6:31 p.m. UTC

Update the man page for newly added selftests commands.
Examples:
 devlink dev selftests run pci/0000:03:00.0 test flash
 devlink dev selftests show pci/0000:03:00.0

Signed-off-by: Vikas Gupta <[e-mail]>
Reviewed-by: Michael Chan <[e-mail]>
Reviewed-by: Andy Gospodarek <[e-mail]>
---
 man/man8/devlink-dev.8 | 46 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

Patch

diff --git a/man/man8/devlink-dev.8 b/man/man8/devlink-dev.8
index 6906e509..057551a8 100644
--- a/man/man8/devlink-dev.8
+++ b/man/man8/devlink-dev.8
@@ -85,6 +85,16 @@  devlink-dev \- devlink device configuration
 .I ID
 ]
 
+.ti -8
+.B devlink dev selftests show
+.I DEV
+
+.ti -8
+.B devlink dev selftests run
+.I DEV
+.B test
+.I TESTNAME
+
 .SH "DESCRIPTION"
 .SS devlink dev show - display devlink device attributes
 
@@ -249,6 +259,32 @@  should match the component names from
 .B "devlink dev info"
 and may be driver-dependent.
 
+.SS devlink dev selftests show - shows supported selftests on devlink device.
+
+.PP
+.I "DEV"
+- specifies the devlink device.
+
+.SS devlink dev selftests run - runs selftests on devlink device.
+
+.PP
+.I "DEV"
+- specifies the devlink device to execute selftests.
+
+.B test
+{
+.BI " TESTNAME "
+|
+.B " all "
+}
+- The value of
+.I TESTNAME
+should match the test names from
+.B "devlink dev selftests show".
+OR Pass option
+.B "all"
+to execute all the selftests on the devlink device.
+
 .SH "EXAMPLES"
 .PP
 devlink dev show
@@ -296,6 +332,16 @@  Flashing 100%
 .br
 Flashing done
 .RE
+.PP
+devlink dev selftests show pci/0000:01:00.0
+.RS 4
+Shows the supported selftests by the devlink device.
+.RE
+.PP
+devlink dev selftests run pci/0000:01:00.0 test flash
+.RS 4
+Perform a flash test on the devlink device.
+.RE
 
 .SH SEE ALSO
 .BR devlink (8),