[ovs-dev] [PATCH] dpdk: Update documentation.
blp at nicira.com
Thu Aug 7 23:47:02 UTC 2014
On Thu, Aug 07, 2014 at 07:20:41PM -0300, Flavio Leitner wrote:
> On Thu, Aug 07, 2014 at 01:46:52PM -0700, Pravin Shelar wrote:
> > On Thu, Aug 7, 2014 at 12:55 PM, Ben Pfaff <blp at nicira.com> wrote:
> > > On Thu, Aug 07, 2014 at 12:40:34PM -0700, Pravin B Shelar wrote:
> > >> Add usage info for ovs-vswitchd dpdk option. Update
> > >> INSTALL.DPDK file.
> > >>
> > >> Reported-by: Hari Sasank Bhamidipalli <hbhamidi at cisco.com>
> > >> Signed-off-by: Pravin B Shelar <pshelar at nicira.com>
> > >
> > > I see that this references INSTALL.DPDK from the --help message. It
> > > looks like there's only a few sentences in INSTALL.DPDK on the --dpdk
> > > option. To me, that makes it seem like it would be easy enough to add
> > > those sentences to ovs-vswitchd(8), and then people would easily find
> > > the documentation in the expected place.
> > I thought abut that.
> > But just having --dpdk option does not work. User will have to refer
> > INSTALL.DPDK doc for other setup steps. So rather than reading two
> > docs, user can have all information about dpdk setup in INSTALL.DPDK.
> > I can add a pointer to INSTALL.DPDK in man page, what do you think?
> I don't think INSTALL.DPDK is packaged in any distro, so pointing to
> that file doesn't help much if you got ovs from .deb or .rpm packages.
> Perhaps dpdk setup deserves a man-page itself and the --dpdk help
> could point to that man-page.
That's probably for the best.
As an alternative, it would be easy to install INSTALL.DPDK, e.g. for
Debian I think all you need is:
diff --git a/debian/openvswitch-common.docs b/debian/openvswitch-common.docs
index d6360a1..3bd2ca3 100644
@@ -1 +1,2 @@
More information about the dev