netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jiri Pirko <jiri@resnulli.us>
To: netdev@vger.kernel.org
Cc: dsahern@gmail.com, stephen@networkplumber.org, mlxsw@mellanox.com
Subject: [patch iproute2/net-next 8/8] man: add man page for devlink dpipe
Date: Sat,  4 Apr 2020 18:16:21 +0200	[thread overview]
Message-ID: <20200404161621.3452-9-jiri@resnulli.us> (raw)
In-Reply-To: <20200404161621.3452-1-jiri@resnulli.us>

From: Jiri Pirko <jiri@mellanox.com>

Add simple man page for devlink dpipe.

Signed-off-by: Jiri Pirko <jiri@mellanox.com>
---
 man/man8/devlink-dpipe.8 | 100 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 man/man8/devlink-dpipe.8

diff --git a/man/man8/devlink-dpipe.8 b/man/man8/devlink-dpipe.8
new file mode 100644
index 000000000000..00379401208e
--- /dev/null
+++ b/man/man8/devlink-dpipe.8
@@ -0,0 +1,100 @@
+.TH DEVLINK\-DPIPE 8 "4 Apr 2020" "iproute2" "Linux"
+.SH NAME
+devlink-dpipe \- devlink dataplane pipeline visualization 
+.SH SYNOPSIS
+.sp
+.ad l
+.in +8
+.ti -8
+.B devlink
+.RI "[ " OPTIONS " ]"
+.B dpipe
+.RB "{ " table " | " header " }"
+.RI "{ " COMMAND " | "
+.BR help " }"
+.sp
+
+.ti -8
+.IR OPTIONS " := { "
+\fB\-V\fR[\fIersion\fR] }
+
+.ti -8
+.BI "devlink dpipe table show " DEV
+.R [
+.BI name " TABLE_NAME "
+.R ]
+
+.ti -8
+.BI "devlink dpipe table set " DEV
+.BI name " TABLE_NAME "
+
+.ti -8
+.BI "devlink dpipe table dump " DEV
+.BI name " TABLE_NAME "
+
+.ti -8
+.BI "devlink dpipe header show " DEV
+
+.ti -8
+.B devlink dpipe help
+
+.SH "DESCRIPTION"
+.SS devlink dpipe table show - display devlink dpipe table attributes
+
+.TP
+.BI name " TABLE_NAME"
+Specifies the table to operate on.
+
+.SS devlink dpipe table set - set devlink dpipe table attributes
+
+.TP
+.BI name " TABLE_NAME"
+Specifies the table to operate on.
+
+.SS devlink dpipe table dump - dump devlink dpipe table entries
+
+.TP
+.BI name " TABLE_NAME"
+Specifies the table to operate on.
+
+.SS devlink dpipe header show - display devlink dpipe header attributes
+
+.TP
+.BI name " TABLE_NAME"
+Specifies the table to operate on.
+
+.SH "EXAMPLES"
+.PP
+devlink dpipe table show pci/0000:01:00.0
+.RS 4
+Shows all dpipe tables on specified devlink device.
+.RE
+.PP
+devlink dpipe table show pci/0000:01:00.0 name mlxsw_erif
+.RS 4
+Shows mlxsw_erif dpipe table on specified devlink device.
+.RE
+.PP
+devlink dpipe table set pci/0000:01:00.0 name mlxsw_erif counters_enabled true
+.RS 4
+Turns on the counters on mlxsw_erif table.
+.RE
+.PP
+devlink dpipe table dump pci/0000:01:00.0 name mlxsw_erif
+.RS 4
+Dumps content of mlxsw_erif table.
+.RE
+.PP
+devlink dpipe header show pci/0000:01:00.0
+.RS 4
+Shows all dpipe headers on specified devlink device.
+.RE
+
+.SH SEE ALSO
+.BR devlink (8),
+.BR devlink-dev (8),
+.BR devlink-monitor (8),
+.br
+
+.SH AUTHOR
+Jiri Pirko <jiri@mellanox.com>
-- 
2.21.1


  parent reply	other threads:[~2020-04-04 16:16 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-04 16:16 [patch iproute2/net-next 0/8] devlink: spring cleanup Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 1/8] devlink: remove custom bool command line options parsing Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 2/8] devlink: Fix help and man of "devlink health set" command Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 3/8] devlink: fix encap mode manupulation Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 4/8] devlink: Add alias "counters_enabled" for "counters" option Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 5/8] devlink: rename dpipe_counters_enable struct field to dpipe_counters_enabled Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 6/8] devlink: Fix help message for dpipe Jiri Pirko
2020-04-04 16:16 ` [patch iproute2/net-next 7/8] devlink: remove "dev" object sub help messages Jiri Pirko
2020-04-04 16:16 ` Jiri Pirko [this message]
2020-04-06 17:30   ` [patch iproute2/net-next 8/8] man: add man page for devlink dpipe Stephen Hemminger
2020-04-06 18:06     ` Jiri Pirko
2020-04-06  2:21 ` [patch iproute2/net-next 0/8] devlink: spring cleanup Stephen Hemminger
2020-04-06  6:53   ` Jiri Pirko

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=20200404161621.3452-9-jiri@resnulli.us \
    --to=jiri@resnulli.us \
    --cc=dsahern@gmail.com \
    --cc=mlxsw@mellanox.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).