[ovs-dev,v2,1/3] vswitchd: Document netdev-dpdk commands.

Message ID 1510297926-18710-2-git-send-email-i.maximets@samsung.com
State New
Headers show
Series
  • netdev-dpdk: Mempool creation failure + Appctl
Related show

Commit Message

Ilya Maximets Nov. 10, 2017, 7:12 a.m.
Signed-off-by: Ilya Maximets <i.maximets@samsung.com>
Acked-by: Antonio Fischetti <antonio.fischetti@intel.com>
---
 NEWS                        | 2 ++
 lib/automake.mk             | 1 +
 lib/netdev-dpdk-unixctl.man | 9 +++++++++
 manpages.mk                 | 2 ++
 vswitchd/ovs-vswitchd.8.in  | 1 +
 5 files changed, 15 insertions(+)
 create mode 100644 lib/netdev-dpdk-unixctl.man

Patch

diff --git a/NEWS b/NEWS
index a93237f..ccd409f 100644
--- a/NEWS
+++ b/NEWS
@@ -12,6 +12,8 @@  Post-v2.8.0
          IPv6 packets.
    - Linux kernel 4.13
      * Add support for compiling OVS with the latest Linux 4.13 kernel
+   - DPDK:
+     * 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 effe5b5..4b38a11 100644
--- a/lib/automake.mk
+++ b/lib/automake.mk
@@ -465,6 +465,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..a4b7f60
--- /dev/null
+++ b/lib/netdev-dpdk-unixctl.man
@@ -0,0 +1,9 @@ 
+.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.
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