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

[Ben Pfaff]

On Thu, Aug 07, 2014 at 09:43:34PM -0300, Flavio Leitner wrote:
> On Thu, Aug 07, 2014 at 04:47:02PM -0700, Ben Pfaff wrote:
> > 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
> > --- a/debian/openvswitch-common.docs
> > +++ b/debian/openvswitch-common.docs
> > @@ -1 +1,2 @@
> >  FAQ
> > +INSTALL.DPDK
> 
> Here is what you need for the rpm spec files to put together
> with your patch. I am adding more files because they are useful
> too. Feel free to remove them if you don't agree.
> 
> Signed-off-by: Flavio Leitner <fbl at redhat.com>
> 
> diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in
> index 30fe439..9f66f41 100644
> --- a/rhel/openvswitch-fedora.spec.in
> +++ b/rhel/openvswitch-fedora.spec.in
> @@ -201,6 +201,7 @@ systemctl start openvswitch.service
>  %doc /usr/share/man/man8/ovs-test.8.gz
>  %doc /usr/share/man/man8/ovs-l3ping.8.gz
>  %doc /usr/share/man/man8/vtep-ctl.8.gz
> +%doc COPYING DESIGN INSTALL.SSL NOTICE README WHY-OVS FAQ NEWS INSTALL.DPDK
>  /var/lib/openvswitch
>  /var/log/openvswitch
>  /usr/share/openvswitch/scripts/ovs-ctl
> diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
> index c817cce..251cfe5 100644
> --- a/rhel/openvswitch.spec.in
> +++ b/rhel/openvswitch.spec.in
> @@ -55,9 +55,6 @@ rhel_cp etc_sysconfig_network-scripts_ifup-ovs 0755
>  rhel_cp etc_sysconfig_network-scripts_ifdown-ovs 0755
>  rhel_cp usr_share_openvswitch_scripts_sysconfig.template 0644
>  
> -docdir=$RPM_BUILD_ROOT/usr/share/doc/openvswitch-%{version}
> -install -d -m755 "$docdir"
> -install -m 0644 FAQ rhel/README.RHEL "$docdir"
>  install python/compat/uuid.py $RPM_BUILD_ROOT/usr/share/openvswitch/python
>  install python/compat/argparse.py $RPM_BUILD_ROOT/usr/share/openvswitch/python
>  
> @@ -175,7 +172,7 @@ exit 0
>  /usr/share/openvswitch/scripts/sysconfig.template
>  /usr/share/openvswitch/vswitch.ovsschema
>  /usr/share/openvswitch/vtep.ovsschema
> -/usr/share/doc/openvswitch-%{version}/FAQ
> -/usr/share/doc/openvswitch-%{version}/README.RHEL
> +%doc COPYING DESIGN INSTALL.SSL NOTICE README WHY-OVS FAQ NEWS
> +%doc INSTALL.DPDK rhel/README.RHEL
>  /var/lib/openvswitch
>  /var/log/openvswitch

Pravin, are you willing to fold these changes (to the Debian and RHEL
packaging) into your documentation update?  If not, let me know, and I
will formally write them up myself.