[ovs-dev] [PATCH 3/2] vswitchd: Document netdev-dpdk commands.

[Fischetti, Antonio]

Thanks, LGTM.
-Antonio

Acked-by: Antonio Fischetti <antonio.fischetti at intel.com>

> -----Original Message-----
> From: Ilya Maximets [mailto:i.maximets at samsung.com]
> Sent: Tuesday, October 31, 2017 3:18 PM
> To: ovs-dev at openvswitch.org
> Cc: Heetae Ahn <heetae82.ahn at samsung.com>; Fischetti, Antonio
> <antonio.fischetti at intel.com>; Loftus, Ciara <ciara.loftus at intel.com>;
> Kavanagh, Mark B <mark.b.kavanagh at intel.com>; Stokes, Ian
> <ian.stokes at intel.com>; Wojciechowicz, RobertX
> <robertx.wojciechowicz at intel.com>; Ilya Maximets <i.maximets at samsung.com>
> Subject: [PATCH 3/2] vswitchd: Document netdev-dpdk commands.
> 
> Signed-off-by: Ilya Maximets <i.maximets at samsung.com>
> ---
>  NEWS                        |  3 +++
>  lib/automake.mk             |  1 +
>  lib/netdev-dpdk-unixctl.man | 13 +++++++++++++
>  manpages.mk                 |  2 ++
>  vswitchd/ovs-vswitchd.8.in  |  1 +
>  5 files changed, 20 insertions(+)
>  create mode 100644 lib/netdev-dpdk-unixctl.man
> 
> diff --git a/NEWS b/NEWS
> index 1325d31..6c09d71 100644
> --- a/NEWS
> +++ b/NEWS
> @@ -5,6 +5,9 @@ Post-v2.8.0
>         chassis "hostname" in addition to a chassis "name".
>     - Linux kernel 4.13
>       * Add support for compiling OVS with the latest Linux 4.13 kernel
> +   - DPDK:
> +     * New debug appctl command 'netdev-dpdk/get-mempool-info'.
> +     * All the netdev-dpdk appctl commands described in ovs-vswitchd man page.
> 
>  v2.8.0 - 31 Aug 2017
>  --------------------
> diff --git a/lib/automake.mk b/lib/automake.mk
> index ca1cf5d..f6a82d5 100644
> --- a/lib/automake.mk
> +++ b/lib/automake.mk
> @@ -467,6 +467,7 @@ MAN_FRAGMENTS += \
>  	lib/db-ctl-base.man \
>  	lib/dpctl.man \
>  	lib/memory-unixctl.man \
> +	lib/netdev-dpdk-unixctl.man \
>  	lib/ofp-version.man \
>  	lib/ovs.tmac \
>  	lib/service.man \
> diff --git a/lib/netdev-dpdk-unixctl.man b/lib/netdev-dpdk-unixctl.man
> new file mode 100644
> index 0000000..73b2e10
> --- /dev/null
> +++ b/lib/netdev-dpdk-unixctl.man
> @@ -0,0 +1,13 @@
> +.SS "NETDEV-DPDK COMMANDS"
> +These commands manage DPDK related ports (\fItype=dpdk*\fR).
> +.IP "\fBnetdev-dpdk/set-admin-state\fR [\fIinterface\fR] \fIstate\fR"
> +Sets admin state for DPDK \fIinterface\fR (or all interfaces if none is given)
> +to \fIstate\fR.  \fIstate\fR can be "up" or "down".
> +.IP "\fBnetdev-dpdk/detach\fR \fIpci-address\fR"
> +Detaches device with corresponding \fIpci-address\fR from DPDK.  This command
> +can be used to detach device if it wasn't detached automatically after port
> +deletion. Refer to the documentation for details and instructions.
> +.IP "\fBnetdev-dpdk/get-mempool-info\fR [\fIinterface\fR]"
> +Prints the debug information about memory pool used by DPDK \fIinterface\fR.
> +If called without arguments, information of all the available mempools will
> +be printed.
> diff --git a/manpages.mk b/manpages.mk
> index d610d88..c89bc45 100644
> --- a/manpages.mk
> +++ b/manpages.mk
> @@ -279,6 +279,7 @@ vswitchd/ovs-vswitchd.8: \
>  	lib/daemon.man \
>  	lib/dpctl.man \
>  	lib/memory-unixctl.man \
> +	lib/netdev-dpdk-unixctl.man \
>  	lib/service.man \
>  	lib/ssl-bootstrap.man \
>  	lib/ssl.man \
> @@ -296,6 +297,7 @@ lib/coverage-unixctl.man:
>  lib/daemon.man:
>  lib/dpctl.man:
>  lib/memory-unixctl.man:
> +lib/netdev-dpdk-unixctl.man:
>  lib/service.man:
>  lib/ssl-bootstrap.man:
>  lib/ssl.man:
> diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
> index c18baf6..76ccfcb 100644
> --- a/vswitchd/ovs-vswitchd.8.in
> +++ b/vswitchd/ovs-vswitchd.8.in
> @@ -283,6 +283,7 @@ port names, which this thread polls.
>  .IP "\fBdpif-netdev/pmd-rxq-rebalance\fR [\fIdp\fR]"
>  Reassigns rxqs to pmds in the datapath \fIdp\fR based on their current usage.
>  .
> +.so lib/netdev-dpdk-unixctl.man
>  .so ofproto/ofproto-dpif-unixctl.man
>  .so ofproto/ofproto-unixctl.man
>  .so lib/vlog-unixctl.man
> --
> 2.7.4