netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Vikas Gupta <vikas.gupta@broadcom.com>
To: jiri@nvidia.com, dsahern@kernel.org, stephen@networkplumber.org
Cc: kuba@kernel.org, netdev@vger.kernel.org, edumazet@google.com,
	michael.chan@broadcom.com, andrew.gospodarek@broadcom.com,
	Vikas Gupta <vikas.gupta@broadcom.com>
Subject: [PATCH iproute2-next v2 3/3] devlink : update man page for new commands
Date: Fri,  8 Jul 2022 00:01:16 +0530	[thread overview]
Message-ID: <20220707183116.29422-4-vikas.gupta@broadcom.com> (raw)
In-Reply-To: <20220707183116.29422-1-vikas.gupta@broadcom.com>

[-- Attachment #1: Type: text/plain, Size: 1861 bytes --]

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 <vikas.gupta@broadcom.com>
Reviewed-by: Michael Chan <michael.chan@broadcom.com>
Reviewed-by: Andy Gospodarek <andrew.gospodarek@broadcom.com>
---
 man/man8/devlink-dev.8 | 46 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

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),
-- 
2.31.1


[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 4206 bytes --]

  parent reply	other threads:[~2022-07-07 18:34 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-06-28 16:44 [PATCH iproute2-next v1 0/2] devlink: add support to run selftests Vikas Gupta
2022-06-28 16:44 ` [PATCH iproute2-next v1 1/2] Update kernel header Vikas Gupta
2022-06-28 16:44 ` [PATCH iproute2-next v1 2/2] devlink: add support for running selftests Vikas Gupta
2022-06-29 11:37 ` [PATCH iproute2-next v1 0/2] devlink: add support to run selftests Ido Schimmel
2022-07-07 18:31 ` [PATCH iproute2-next v2 0/3] " Vikas Gupta
2022-07-07 18:31   ` [PATCH iproute2-next v2 1/3] devlink: update the devlink.h Vikas Gupta
2022-07-07 18:31   ` [PATCH iproute2-next v2 2/3] devlink: add support for running selftests Vikas Gupta
2022-07-07 18:31   ` Vikas Gupta [this message]
2022-07-10  8:56   ` [PATCH iproute2-next v2 0/3] devlink: add support to run selftests Ido Schimmel
2022-07-18  6:22   ` [PATCH iproute2-next v3 0/3] devlink: add support to run selftest Vikas Gupta
2022-07-18  6:22     ` [PATCH iproute2-next v3 1/3] devlink: update the devlink.h Vikas Gupta
2022-07-18  6:22     ` [PATCH iproute2-next v3 2/3] devlink: add support for running selftests Vikas Gupta
2022-07-18  6:22     ` [PATCH iproute2-next v3 3/3] devlink : update man page and bash-completion for new commands Vikas Gupta

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220707183116.29422-4-vikas.gupta@broadcom.com \
    --to=vikas.gupta@broadcom.com \
    --cc=andrew.gospodarek@broadcom.com \
    --cc=dsahern@kernel.org \
    --cc=edumazet@google.com \
    --cc=jiri@nvidia.com \
    --cc=kuba@kernel.org \
    --cc=michael.chan@broadcom.com \
    --cc=netdev@vger.kernel.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).