[ovs-dev] [PATCH ovn 1/3] ovn-nbctl: Improve manpage.

Mark Michelson mmichels at redhat.com
Wed Mar 31 13:57:33 UTC 2021

On 3/30/21 6:18 PM, Ben Pfaff wrote:
> On Mon, Mar 29, 2021 at 07:42:47PM -0400, Mark Michelson wrote:
>> On 3/25/21 7:26 PM, Ben Pfaff wrote:
>>> This rearranges the manpage into a more logical order, documents some
>>> options that weren't documented, adds some sections such as
>>> Environment and Exit Status that a manpage should have, puts the
>>> headings at reasonable levels instead of all at the top level, and adds
>>> a little more explanatory text in a few places.
>>> Signed-off-by: Ben Pfaff <blp at ovn.org>
> ...
>>> +    <p>
>>> +      Daemon mode is experimental.
>>> +    </p>
>> Is daemon mode really still experimental? For ovn-nbctl, it's been around a
>> couple of years at this point and was used heavily by ovn-kubernetes with no
>> issues.
> OK, I'll add a patch.
>>> +
>>> +    <h3>Daemon Commands</h3>
>>> +
>>> +    <p>
>>> +      Daemon mode is internally implemented using the same mechanism used by
>>> +      <code>ovs-appctl</code>.  One may also use <code>ovs-appctl</code>
>> I believe you should replace "ovs-appctl" above with "ovn-appctl". I'm aware
>> this was just copied from text that had previously been in the manpage, but
>> the original text was wrong as well.
>> This same mention is made in patch 3 for the ovn-sbctl daemon and should
>> probably be amended there too.
> I was not previously aware that ovn-appctl existed.  Looking at a diff
> between ovs-appctl.c and ovn-appctl.c didn't clear up why it exists.
> They are exactly the same except for naming and changing the default
> target from ovs-vswitchd to ovn-controller.  They will work exactly as
> well for the purpose of this manpage.

The other big difference is that ovn-appctl by default looks in 
ovn_rundir() instead of ovs_rundir() by default when searching for the 

> So, OK, I made those changes.  Can't hurt.
>> Should ovn-appctl also be in the "See Also" section since it is mentioned by
>> name earlier?
> OK, done for v2.
> Thank you!

And thanks for the improvements!

More information about the dev mailing list