[ovs-dev] [PATCH] dpdk: Update documentation.

Ben Pfaff blp at nicira.com
Thu Aug 7 20:50:17 UTC 2014


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?

That will also help users find the documentation, so I think that's a
good approach for now.



More information about the dev mailing list