diff mbox series

[ovs-dev,2/3] dpif-netdev-unixctl.man: Document miniflow-parser-* CMDs

Message ID 20210728131941.3649-2-cian.ferriter@intel.com
State Superseded
Headers show
Series [ovs-dev,1/3] dpif-netdev-unixctl.man: Document subtable-lookup-* CMDs | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot fail github build: failed

Commit Message

Ferriter, Cian July 28, 2021, 1:19 p.m. UTC
Fixes: 3d8f47bc041a ("dpif-netdev: Add command line and function pointer for miniflow extract")
Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>
---
 lib/dpif-netdev-unixctl.man | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Stokes, Ian Aug. 12, 2021, 2:46 p.m. UTC | #1
> Fixes: 3d8f47bc041a ("dpif-netdev: Add command line and function pointer for
> miniflow extract")
> Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>

Hi Cian, as before a one line summary line in the message body would be appreciated.

> ---
>  lib/dpif-netdev-unixctl.man | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/lib/dpif-netdev-unixctl.man b/lib/dpif-netdev-unixctl.man
> index c44c7eaa0..ceb107f90 100644
> --- a/lib/dpif-netdev-unixctl.man
> +++ b/lib/dpif-netdev-unixctl.man
> @@ -247,3 +247,13 @@ Lists the DPIF implementations that are available.
>  .
>  .IP "\fBdpif-netdev/dpif-impl-set\fR \fIdpif_impl\fR"
>  Sets the DPIF to be used to \fIdpif_impl\fR. By default "dpif_scalar" is used.
> +.
> +.IP "\fBdpif-netdev/miniflow-parser-get\fR
> +Lists the miniflow extract implementations that are available.
> +.
> +.IP "\fBdpif-netdev/miniflow-parser-set\fR [\fB-pmd\fR \fIcore\fR] \
> +\fIminiflow_impl\fR [\fIstudy_cnt\fR]"
> +Sets the miniflow extract to be used for one or all pmd threads to

Would maybe re-word this to sets the miniflow extract to be used for a specified PMD or all PMDs in the case where no value is specified.

Just to make it clear the behavior if the argument is not provided.

BR
Ian

> +\fIminiflow_impl\fR.  By default "scalar" is used. \fIstudy_cnt\fR defaults to
> +128 and indicates the number of packets that the "study" miniflow
> +implementation must parse before choosing an optimal implementation.
> --
> 2.32.0
> 
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Ferriter, Cian Aug. 13, 2021, 3:41 p.m. UTC | #2
> -----Original Message-----
> From: Stokes, Ian <ian.stokes@intel.com>
> Sent: Thursday 12 August 2021 15:46
> To: Ferriter, Cian <cian.ferriter@intel.com>; ovs-dev@openvswitch.org
> Cc: fbl@sysclose.org
> Subject: RE: [ovs-dev] [PATCH 2/3] dpif-netdev-unixctl.man: Document miniflow-parser-* CMDs
> 
> > Fixes: 3d8f47bc041a ("dpif-netdev: Add command line and function pointer for
> > miniflow extract")
> > Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>
> 
> Hi Cian, as before a one line summary line in the message body would be appreciated.
> 

Added in the next version.

> > ---
> >  lib/dpif-netdev-unixctl.man | 10 ++++++++++
> >  1 file changed, 10 insertions(+)
> >
> > diff --git a/lib/dpif-netdev-unixctl.man b/lib/dpif-netdev-unixctl.man
> > index c44c7eaa0..ceb107f90 100644
> > --- a/lib/dpif-netdev-unixctl.man
> > +++ b/lib/dpif-netdev-unixctl.man
> > @@ -247,3 +247,13 @@ Lists the DPIF implementations that are available.
> >  .
> >  .IP "\fBdpif-netdev/dpif-impl-set\fR \fIdpif_impl\fR"
> >  Sets the DPIF to be used to \fIdpif_impl\fR. By default "dpif_scalar" is used.
> > +.
> > +.IP "\fBdpif-netdev/miniflow-parser-get\fR
> > +Lists the miniflow extract implementations that are available.
> > +.
> > +.IP "\fBdpif-netdev/miniflow-parser-set\fR [\fB-pmd\fR \fIcore\fR] \
> > +\fIminiflow_impl\fR [\fIstudy_cnt\fR]"
> > +Sets the miniflow extract to be used for one or all pmd threads to
> 
> Would maybe re-word this to sets the miniflow extract to be used for a specified PMD or all PMDs in
> the case where no value is specified.
> 
> Just to make it clear the behavior if the argument is not provided.
> 

Fixed in the next version.

> BR
> Ian
> 

Thanks for the review Ian.

> > +\fIminiflow_impl\fR.  By default "scalar" is used. \fIstudy_cnt\fR defaults to
> > +128 and indicates the number of packets that the "study" miniflow
> > +implementation must parse before choosing an optimal implementation.
> > --
> > 2.32.0
> >
> > _______________________________________________
> > dev mailing list
> > dev@openvswitch.org
> > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff mbox series

Patch

diff --git a/lib/dpif-netdev-unixctl.man b/lib/dpif-netdev-unixctl.man
index c44c7eaa0..ceb107f90 100644
--- a/lib/dpif-netdev-unixctl.man
+++ b/lib/dpif-netdev-unixctl.man
@@ -247,3 +247,13 @@  Lists the DPIF implementations that are available.
 .
 .IP "\fBdpif-netdev/dpif-impl-set\fR \fIdpif_impl\fR"
 Sets the DPIF to be used to \fIdpif_impl\fR. By default "dpif_scalar" is used.
+.
+.IP "\fBdpif-netdev/miniflow-parser-get\fR
+Lists the miniflow extract implementations that are available.
+.
+.IP "\fBdpif-netdev/miniflow-parser-set\fR [\fB-pmd\fR \fIcore\fR] \
+\fIminiflow_impl\fR [\fIstudy_cnt\fR]"
+Sets the miniflow extract to be used for one or all pmd threads to
+\fIminiflow_impl\fR.  By default "scalar" is used. \fIstudy_cnt\fR defaults to
+128 and indicates the number of packets that the "study" miniflow
+implementation must parse before choosing an optimal implementation.