[ovs-dev] [PATCH] ovsdb-doc: Omit E-R diagram from ASCII version of manpage.

[Ben Pfaff]

I didn't mean for the commit message to be unclear.  Here's what I
changed it to:

    ovsdb-doc: Omit E-R diagram from ASCII version of manpage.

    The E-R diagram is illegible when rendered in ASCII, so exclude it from
    that version only.  The E-R diagram is still included in other versions of
    the manpage (e.g. for PostScript output).

I didn't mean for the implementation to be unclear, either, but I have
no idea how to make troff code clear.

On Thu, May 26, 2011 at 02:04:46AM -0700, Justin Pettit wrote:
> Looks good.  Okay, actually, I have no idea.  When you generate a
> man page, is the E-R diagram gone?  Is it still there for the other
> formats?  If "yes" to both of these questions, then: Looks good.
> 
> --Justin
> 
> 
> On May 24, 2011, at 12:42 PM, Ben Pfaff wrote:
> 
> > The E-R diagram is illegible when rendered in ASCII, so exclude it.
> > ---
> > ovsdb/ovsdb-doc.in |    3 ++-
> > 1 files changed, 2 insertions(+), 1 deletions(-)
> > 
> > diff --git a/ovsdb/ovsdb-doc.in b/ovsdb/ovsdb-doc.in
> > index 3c825d2..2577e78 100755
> > --- a/ovsdb/ovsdb-doc.in
> > +++ b/ovsdb/ovsdb-doc.in
> > @@ -286,6 +286,7 @@ Table	Purpose
> > 
> >     if erFile:
> >         s += """
> > +.if !'\*[.T]'ascii' \{
> > .sp 1
> > .SH "TABLE RELATIONSHIPS"
> > .PP
> > @@ -303,7 +304,7 @@ represent strong references; thin lines represent weak references.
> >         for line in erStream:
> >             s += line + '\n'
> >         erStream.close()
> > -        s += ".RE\n"
> > +        s += ".RE\\}\n"
> > 
> >     for node in tableNodes:
> >         s += tableToNroff(schema, node) + "\n"
> > -- 
> > 1.7.4.4
> > 
> > _______________________________________________
> > dev mailing list
> > dev at openvswitch.org
> > http://openvswitch.org/mailman/listinfo/dev
>