[ovs-dev] [ovn-controller-gw 3/4] ovn-sbctl: Add ovn-sbctl.

[Ben Pfaff]

On Fri, Jun 26, 2015 at 08:45:51AM -0700, Alex Wang wrote:
> This commit adds ovn-sbctl to ovn family by using the db-ctl-base
> library.
> 
> Signed-off-by: Alex Wang <alexw at nicira.com>

This is really great!  Thank you for writing this.

In the documentation (which is good--thank you), I would consider
including, near the top, an explanation of when one might want to use
ovn-sbctl.  My guess is that it is mainly for examining the database for
monitoring or troubleshooting, and that the modification commands are
mainly for testing.  If you have some ideas what specific modification
commands are good for, then you might want to add a few words about that
in the command descriptions.

To me, the abbreviation of "chassis" to "ch" in command names does not
seem very natural.  I know that we abbreviate "bridge" to "br" in
ovs-vsctl command names, but that seems qualitatively different to me
somehow.

I have some minor comments.

Add "the" following "configures":
+The \fBovn\-sbctl\fR program configures \fBOVN_Southbound\fR database by
+providing a high\-level interface to its configuration database.

Add "of" following "behavior":
+The following options affect the behavior \fBovn\-sbctl\fR as a whole.

I see the term "binded" is used in multiple places in the manpage.
"bound" reads more naturally to me.

Do you think that ovs-vswitchd and ovs-vswitchd.conf.db are good
references under SEE ALSO?  I would be more inclined to reference
ovn-sb(5), instead.

Acked-by: Ben Pfaff <blp at nicira.com>