[ovs-dev] [PATCH v2] Refer to database manpages in *ctl manpages
Mark Michelson
mmichels at redhat.com
Mon Feb 26 20:05:24 UTC 2018
On 02/26/2018 01:54 PM, Ben Pfaff wrote:
> On Mon, Feb 26, 2018 at 08:30:45AM -0600, Mark Michelson wrote:
>> On 02/23/2018 06:07 PM, Ben Pfaff wrote:
>>> On Thu, Feb 15, 2018 at 04:49:57PM -0600, Mark Michelson wrote:
>>>> The ovn-nbctl, ovn-sbctl, and ovs-vsctl manpages are inconsistent in
>>>> their "Database Commands" section when it comes to referring to what
>>>> database tables exist. This commit amends this by making each *ctl
>>>> manpage reference the corresponding database manpage instead.
>>>>
>>>> To aid in having a more handy list, the --help text of ovn-nbctl,
>>>> ovn-sbctl, and ovs-vsctl have been modified to list the available
>>>> tables. This is also referenced in the manpages for those applications.
>>>>
>>>> Signed-off-by: Mark Michelson <mmichels at redhat.com>
>>>
>>> Thanks. I was hoping for more explanation in the list of tables for how
>>> users can refer to the tables. Here is a version that adds more
>>> information. What do you think?
>>
>> Thanks for the update Ben. I like listing methods of referring to records in
>> each table. I found the formatting to be a bit overwhelming in some cases.
>> For instance, from `ovn-nbctl -h` the DHCP_Options table has this text:
>>
>> DHCP_Options: by UUID, via "dhcpv4_options" of Logical_Switch_Port with
>> matching "name", via "dhcpv4_options" of Logical_Switch_Port with matching
>> "external_ids:neutron:port_name", via "dhcpv6_options" of
>> Logical_Switch_Port with matching "name", or via "dhcpv6_options" of
>> Logical_Switch_Port with matching "external_ids:neutron:port_name"
>>
>> Keep in mind that there is no column-limiting on this, so it stretches
>> across the entire terminal. It makes it hard to visually parse the options.
>> I made a adjustment to the formatting so that it looks more like this:
>>
>> DHCP_Options:
>> by UUID
>> via "dhcpv4_options" of Logical_Switch_Port with matching "name"
>> via "dhcpv4_options" of Logical_Switch_Port with matching
>> "external_ids:neutron:port_name"
>> via "dhcpv6_options" of Logical_Switch_Port with matching "name"
>> via "dhcpv6_options" of Logical_Switch_Port with matching
>> "external_ids:neutron:port_name"
>>
>> Separating the methods by line makes it easier to read IMHO. Here's the
>> change
>
> Thanks. This came through word-wrapped, though. Can you re-send?
>
> Thanks,
>
> Ben.
>
Sorry about that. I sent out a v2 of the patch:
https://patchwork.ozlabs.org/patch/878063/
Mark!
More information about the dev
mailing list