| Message ID | 20200404161621.3452-9-jiri@resnulli.us |
|---|---|
| State | Accepted |
| Delegated to: | stephen hemminger |
| Headers | show |
| Series | devlink: spring cleanup | expand |
On Sat, 4 Apr 2020 18:16:21 +0200 Jiri Pirko <jiri@resnulli.us> wrote: > 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 ] I applied the whole set, but fixed some issues on the man page. You had some trailing white space, and the .R macro is not the right way to do this. Make check runs a script from Debian and it spots that.
Mon, Apr 06, 2020 at 07:30:36PM CEST, stephen@networkplumber.org wrote: >On Sat, 4 Apr 2020 18:16:21 +0200 >Jiri Pirko <jiri@resnulli.us> wrote: > >> 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 ] > >I applied the whole set, but fixed some issues on the man page. >You had some trailing white space, and the .R macro is not the right >way to do this. Make check runs a script from Debian and it spots that. Okay. I'll make sure to run this next time. I had no idea it checkes man. Thanks!
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>