[ovs-dev] [PATCH] docs: Add references to the database schema documentation.

[Ben Pfaff]

Thanks, pushed to master.

On Wed, Jun 20, 2012 at 03:24:24PM -0700, Justin Pettit wrote:
> Looks good to me.
> 
> --Justin
> 
> 
> On Jun 20, 2012, at 3:13 PM, Ben Pfaff wrote:
> 
> > I field lots of questions about "where's the documentation?"  Perhaps this
> > will help.
> > 
> > The changes to ovs-vsctl(8) add a couple of references to
> > ovs-vswitchd.conf.db(5) but they also rephrase a couple of paragraphs in
> > what seems to me an easier to understand style.
> > 
> > Signed-off-by: Ben Pfaff <blp at nicira.com>
> > ---
> > FAQ                      |    4 ++++
> > utilities/ovs-vsctl.8.in |   27 +++++++++++++--------------
> > 2 files changed, 17 insertions(+), 14 deletions(-)
> > 
> > diff --git a/FAQ b/FAQ
> > index 61bbb69..c5882c6 100644
> > --- a/FAQ
> > +++ b/FAQ
> > @@ -129,6 +129,10 @@ A: Wireless base stations generally only allow packets with the source
> >    point, so the same problems will show up with the Linux bridge or
> >    any other way to do bridging.
> > 
> > +Q: Is there any documentation on the database tables and fields?
> > +
> > +A: Yes.  ovs-vswitchd.conf.db(5) is a comprehensive reference.
> > +
> > 
> > VLANs
> > -----
> > diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in
> > index 9ec8d33..0bc0105 100644
> > --- a/utilities/ovs-vsctl.8.in
> > +++ b/utilities/ovs-vsctl.8.in
> > @@ -25,19 +25,17 @@ ovs\-vsctl \- utility for querying and configuring \fBovs\-vswitchd\fR
> > .
> > .SH DESCRIPTION
> > The \fBovs\-vsctl\fR program configures \fBovs\-vswitchd\fR(8) by
> > -providing a high\-level interface to its configuration
> > -database.  This program is mainly intended for use when
> > -\fBovs\-vswitchd\fR is running.  If it is used when
> > -\fBovs\-vswitchd\fR is not running, then \fB\-\-no\-wait\fR should be
> > -specified and configuration changes will only take effect when
> > -\fBovs\-vswitchd\fR is started.
> > -.PP
> > -By default, each time \fBovs\-vsctl\fR runs, it connects to an
> > -\fBovsdb\-server\fR process that maintains an Open vSwitch
> > -configuration database.  Using this connection, it queries and
> > -possibly applies changes to the database, depending on the supplied
> > -commands.  Then, if it applied any changes, it waits until
> > -\fBovs\-vswitchd\fR has finished reconfiguring itself before it exits.
> > +providing a high\-level interface to its configuration database.
> > +See \fBovs\-vswitchd.conf.db\fR(5) for comprehensive documentation of
> > +the database schema.
> > +.PP
> > +\fBovs\-vsctl\fR connects to an \fBovsdb\-server\fR process that
> > +maintains an Open vSwitch configuration database.  Using this
> > +connection, it queries and possibly applies changes to the database,
> > +depending on the supplied commands.  Then, if it applied any changes,
> > +by default it waits until \fBovs\-vswitchd\fR has finished
> > +reconfiguring itself before it exits.  (If you use \fBovs\-vsctl\fR
> > +when \fBovs\-vswitchd\fR is not running, use \fB\-\-no\-wait\fR.)
> > .PP
> > \fBovs\-vsctl\fR can perform any number of commands in a single run,
> > implemented as a single atomic transaction against the database.
> > @@ -918,4 +916,5 @@ bridge that does not exist.
> > .SH "SEE ALSO"
> > .
> > .BR ovsdb\-server (1),
> > -.BR ovs\-vswitchd (8).
> > +.BR ovs\-vswitchd (8),
> > +.BR ovs\-vswitchd.conf.db (5).
> > -- 
> > 1.7.2.5
> > 
> > _______________________________________________
> > dev mailing list
> > dev at openvswitch.org
> > http://openvswitch.org/mailman/listinfo/dev
>