[ovs-dev] [PATCH 10/15] doc: Convert README-native-tunneling to rST

Russell Bryant russell at ovn.org
Sat Oct 29 16:26:56 UTC 2016


On Sat, Oct 29, 2016 at 1:50 PM, Stephen Finucane <stephen at that.guru> wrote:

> On 28 Oct 23:25, Russell Bryant wrote:
> > On Tue, Oct 18, 2016 at 10:03 PM, Stephen Finucane <stephen at that.guru>
> > wrote:
> >
> > > Signed-off-by: Stephen Finucane <stephen at that.guru>
> > > ---
> > >  Makefile.am                     |   2 +-
> > >  README-native-tunneling.md      |  85 -------------------
> > >  README-native-tunneling.rst     | 176 ++++++++++++++++++++++++++++++
> > > ++++++++++
> > >  debian/openvswitch-common.docs  |   2 +-
> > >  ofproto/ofproto-tnl-unixctl.man |   2 +-
> > >  rhel/openvswitch.spec.in        |   2 +-
> > >  utilities/ovs-sim.1.xml         |   2 +-
> > >  7 files changed, 181 insertions(+), 90 deletions(-)
> > >  delete mode 100644 README-native-tunneling.md
> > >  create mode 100644 README-native-tunneling.rst
> > >
> >
> > I've applied patches 9 and 10 to master.
>
> Excellent. You'll be delighted to hear I've the next batch lined up and
> waiting :)
>

Great.  I'm just trying to fit this in here and there.  I'll get through
them eventually.  :-)


> I do have a question though: there are READMEs in both the RHEL and
> Debian packaging directories. I'm not sure should/can these be
> converted to rST nor if they're something worth indexing for the docs.
> Would you know what the custom is here?
>

I'm not sure that I can indicate custom, but I can provide an opinion!

In general, I assume most documents are worth indexing.  I'm imagining that
we'll make a new index page once we get to sphinx.  Once we're there, we
can more clearly organize docs a bit by the audience.

README.RHEL definitely looks work publishing.  We should minimize sphinx
usage, as it's also installed as plain text by the OVS RPM.

I'm not sure which debian readme you're referring to from a quick look.

-- 
Russell Bryant



More information about the dev mailing list