From patchwork Mon Feb 12 20:17:53 2018
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Mark Michelson
X-Patchwork-Id: 872361
Return-Path:
X-Original-To: incoming@patchwork.ozlabs.org
Delivered-To: patchwork-incoming@bilbo.ozlabs.org
Authentication-Results: ozlabs.org;
spf=pass (mailfrom) smtp.mailfrom=openvswitch.org
(client-ip=140.211.169.12; helo=mail.linuxfoundation.org;
envelope-from=ovs-dev-bounces@openvswitch.org;
receiver=)
Received: from mail.linuxfoundation.org (mail.linuxfoundation.org
[140.211.169.12])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256
bits)) (No client certificate requested)
by ozlabs.org (Postfix) with ESMTPS id 3zgH6J1Xsdz9sRm
for ;
Tue, 13 Feb 2018 07:17:59 +1100 (AEDT)
Received: from mail.linux-foundation.org (localhost [127.0.0.1])
by mail.linuxfoundation.org (Postfix) with ESMTP id 53882F88;
Mon, 12 Feb 2018 20:17:57 +0000 (UTC)
X-Original-To: dev@openvswitch.org
Delivered-To: ovs-dev@mail.linuxfoundation.org
Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org
[172.17.192.35])
by mail.linuxfoundation.org (Postfix) with ESMTPS id 89FC8F7E
for ; Mon, 12 Feb 2018 20:17:55 +0000 (UTC)
X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6
Received: from mx1.redhat.com (mx3-rdu2.redhat.com [66.187.233.73])
by smtp1.linuxfoundation.org (Postfix) with ESMTPS id D5491405
for ; Mon, 12 Feb 2018 20:17:54 +0000 (UTC)
Received: from smtp.corp.redhat.com
(int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5])
(using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
(No client certificate requested)
by mx1.redhat.com (Postfix) with ESMTPS id 0318C7D83B
for ; Mon, 12 Feb 2018 20:17:54 +0000 (UTC)
Received: from monae.redhat.com (ovpn-122-131.rdu2.redhat.com
[10.10.122.131])
by smtp.corp.redhat.com (Postfix) with ESMTP id DA04DAE7A1
for ; Mon, 12 Feb 2018 20:17:53 +0000 (UTC)
From: Mark Michelson
To: dev@openvswitch.org
Date: Mon, 12 Feb 2018 14:17:53 -0600
Message-Id: <20180212201753.16254-1-mmichels@redhat.com>
X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16
(mx1.redhat.com [10.11.55.2]);
Mon, 12 Feb 2018 20:17:54 +0000 (UTC)
X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com
[10.11.55.2]);
Mon, 12 Feb 2018 20:17:54 +0000 (UTC) for IP:'10.11.54.5'
DOMAIN:'int-mx05.intmail.prod.int.rdu2.redhat.com'
HELO:'smtp.corp.redhat.com' FROM:'mmichels@redhat.com' RCPT:''
X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW,
T_RP_MATCHES_RCVD autolearn=ham version=3.3.1
X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on
smtp1.linux-foundation.org
Subject: [ovs-dev] [PATCH] Refer to database manpages in *ctl manpages
X-BeenThere: ovs-dev@openvswitch.org
X-Mailman-Version: 2.1.12
Precedence: list
List-Id:
List-Unsubscribe: ,
List-Archive:
List-Post:
List-Help:
List-Subscribe: ,
MIME-Version: 1.0
Sender: ovs-dev-bounces@openvswitch.org
Errors-To: ovs-dev-bounces@openvswitch.org
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.
Signed-off-by: Mark Michelson
---
While having a look through the manpages for ovn-nbctl, ovn-sbctl, and
ovs-vsctl, I noticed that each of them were different with regards to
referring to tables:
* ovn-nbctl listed tables but the list was incomplete.
* ovn-sbctl listed no tables at all.
* ovs-vsctl listed all tables.
To me, there were two ways to go here: list all tables in each of the
three manpages, or list no tables in the three manpages. In the end, I
decided to make a reference to the database manpages. This way we're not
repeating table listings and there's no risk of omitting tables. The
database manpages are better references anyway for tables and their
columns.
---
ovn/utilities/ovn-nbctl.8.xml | 60 +++----------------------------------------
ovn/utilities/ovn-sbctl.8.in | 4 +--
utilities/ovs-vsctl.8.in | 50 +-----------------------------------
3 files changed, 6 insertions(+), 108 deletions(-)
diff --git a/ovn/utilities/ovn-nbctl.8.xml b/ovn/utilities/ovn-nbctl.8.xml
index 4d0aea963..5a8f5dacf 100644
--- a/ovn/utilities/ovn-nbctl.8.xml
+++ b/ovn/utilities/ovn-nbctl.8.xml
@@ -820,64 +820,10 @@
additional ways to identify records. Some commands also take
column parameters that identify a particular field within the
records in a table.
- The following tables are currently defined:
-
- Logical_Switch
- -
- An L2 logical switch. Records may be identified by name.
-
-
- Logical_Switch_Port
- -
- A port within an L2 logical switch. Records may be identified by name.
-
-
- ACL
- -
- An ACL rule for a logical switch that points to it through its acls column.
-
-
- Logical_Router
- -
- An L3 logical router. Records may be identified by name.
-
-
- Logical_Router_Port
- -
- A port within an L3 logical router. Records may be identified by name.
-
-
- Logical_Router_Static_Route
- -
- A static route belonging to an L3 logical router.
-
- Address_Set
- -
- An address set that can be used in ACLs.
-
-
- Load_Balancer
- -
- A load balancer for a logical switch that points to it through its load_balancer column.
-
-
- NAT
- -
- A NAT rule for a Gateway router.
-
-
- DHCP_Options
- -
- DHCP options.
-
-
- NB_Global
- -
- North bound global configurations.
-
-
-
+
+ For a list of tables and their columns, see ovn-nb
(5).
+
Record names must be specified in full and with correct capitalization,
diff --git a/ovn/utilities/ovn-sbctl.8.in b/ovn/utilities/ovn-sbctl.8.in
index cd43cf3be..40807c1dc 100644
--- a/ovn/utilities/ovn-sbctl.8.in
+++ b/ovn/utilities/ovn-sbctl.8.in
@@ -278,8 +278,8 @@ parameter may be the UUID for a record, and many tables offer
additional ways to identify records. Some commands also take
\fIcolumn\fR parameters that identify a particular field within the
records in a table.
-.\" It would be kind to list all the tables and their supported identifiers
-.\" here.
+.PP
+For a list of tables and their columns, see \fBovn\-sb\fR(5).
.PP
Record names must be specified in full and with correct
capitalization, except that UUIDs may be abbreviated to their first 4
diff --git a/utilities/ovs-vsctl.8.in b/utilities/ovs-vsctl.8.in
index 34f41e4e8..374dd5368 100644
--- a/utilities/ovs-vsctl.8.in
+++ b/utilities/ovs-vsctl.8.in
@@ -530,55 +530,7 @@ additional ways to identify records. Some commands also take
\fIcolumn\fR parameters that identify a particular field within the
records in a table.
.PP
-The following tables are currently defined:
-.IP "\fBOpen_vSwitch\fR"
-Global configuration for an \fBovs\-vswitchd\fR. This table contains
-exactly one record, identified by specifying \fB.\fR as the record
-name.
-.IP "\fBBridge\fR"
-Configuration for a bridge within an Open vSwitch. Records may be
-identified by bridge name.
-.IP "\fBPort\fR"
-A bridge port. Records may be identified by port name.
-.IP "\fBInterface\fR"
-A network device attached to a port. Records may be identified by
-name.
-.IP "\fBFlow_Table\fR"
-Configuration for a particular OpenFlow flow table. Records may be
-identified by name.
-.IP "\fBQoS\fR"
-Quality-of-service configuration for a \fBPort\fR. Records may be
-identified by port name.
-.IP "\fBQueue\fR"
-Configuration for one queue within a \fBQoS\fR configuration. Records
-may only be identified by UUID.
-.IP "\fBMirror\fR"
-A port mirroring configuration attached to a bridge. Records may be
-identified by mirror name.
-.IP "\fBController\fR"
-Configuration for an OpenFlow controller. A controller attached to a
-particular bridge may be identified by the bridge's name.
-.IP "\fBManager\fR"
-Configuration for an OVSDB connection. Records may be identified
-by target (e.g. \fBtcp:1.2.3.4\fR).
-.IP "\fBNetFlow\fR"
-A NetFlow configuration attached to a bridge. Records may be
-identified by bridge name.
-.IP "\fBSSL\fR"
-The global SSL configuration for \fBovs\-vswitchd\fR. The record
-attached to the \fBOpen_vSwitch\fR table may be identified by
-specifying \fB.\fR as the record name.
-.IP "\fBsFlow\fR"
-An sFlow exporter configuration attached to a bridge. Records may be
-identified by bridge name.
-.IP "\fBIPFIX\fR"
-An IPFIX exporter configuration attached to a bridge. Records may be
-identified by bridge name.
-.IP "\fBFlow_Sample_Collector_Set\fR"
-An IPFIX exporter configuration attached to a bridge for sampling
-packets on a per-flow basis using OpenFlow \fBsample\fR actions.
-.IP "\fBAutoAttach\fR"
-Configuration for Auto Attach within a bridge.
+For a list of tables and their columns, see \fBovs-vswitchd.conf.db\fR(5).
.PP
Record names must be specified in full and with correct
capitalization, except that UUIDs may be abbreviated to their first 4