dpdk: Update documentation.

Add usage info for ovs-vswitchd dpdk option. Update INSTALL.DPDK file and man page. Reported-by: Hari Sasank Bhamidipalli <[email protected]> Signed-off-by: Pravin B Shelar <[email protected]> Acked-by: Ben Pfaff <[email protected]> Acked-by: Flavio Leitner <[email protected]>
aleeee · Aug 12, 2014 · d127946 · d127946
1 parent c640e3c
commit d127946
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/AUTHORS b/AUTHORS
@@ -201,6 +201,7 @@ Greg Dahlman            [email protected]
 Gregor Schaffrath       [email protected]
 Guolin Yang             [email protected]
 Gur Stavi               [email protected]
+Hari Sasank Bhamidipalli [email protected]
 Hassan Khan             [email protected]
 Hector Oron             [email protected]
 Henrik Amren            [email protected]

diff --git a/INSTALL.DPDK b/INSTALL.DPDK
@@ -72,8 +72,6 @@ First setup DPDK devices:
       0000:02:00.0  0000:02:00.1  bind  module  new_id  remove_id  uevent  unbind
 
 Prepare system:
-  - load ovs kernel module
-    e.g modprobe openvswitch
   - mount hugetlbfs
     e.g. mount -t hugetlbfs -o pagesize=1G none /mnt/huge/
 
@@ -101,7 +99,8 @@ Start ovsdb-server as discussed in INSTALL doc:
 
 Start vswitchd:
 DPDK configuration arguments can be passed to vswitchd via `--dpdk`
-argument. dpdk arg -c is ignored by ovs-dpdk, but it is a required parameter
+argument. This needs to be first argument passed to vswitchd process.
+dpdk arg -c is ignored by ovs-dpdk, but it is a required parameter
 for dpdk initialization.
 
    e.g.

diff --git a/vswitchd/ovs-vswitchd.8.in b/vswitchd/ovs-vswitchd.8.in
@@ -83,6 +83,10 @@ only allow privileged users, such as the superuser, to use it.
 \fBovs\-vswitchd\fR emits a log message if \fBmlockall()\fR is
 unavailable or unsuccessful.
 .
+.SS "DPDK Options"
+.IP "\fB\-\-dpdk\fR"
+Initialize \fBovs\-vswitchd\fR DPDK datapath.  Refer to INSTALL.DPDK
+for details.
 .SS "Daemon Options"
 .ds DD \
 \fBovs\-vswitchd\fR detaches only after it has connected to the \

diff --git a/vswitchd/ovs-vswitchd.c b/vswitchd/ovs-vswitchd.c
@@ -250,6 +250,8 @@ usage(void)
     stream_usage("DATABASE", true, false, true);
     daemon_usage();
     vlog_usage();
+    printf("\nDPDK options:\n"
+           "  --dpdk options          Initialize DPDK datapath.\n");
     printf("\nOther options:\n"
            "  --unixctl=SOCKET        override default control socket name\n"
            "  -h, --help              display this help message\n"