From patchwork Sat Dec 23 06:40:05 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Pettit X-Patchwork-Id: 852614 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 3z3bP85SQdz9s74 for ; Sat, 23 Dec 2017 17:40:59 +1100 (AEDT) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id E94C1958; Sat, 23 Dec 2017 06:40:56 +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 9A0C28EE for ; Sat, 23 Dec 2017 06:40:55 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 249EC403 for ; Sat, 23 Dec 2017 06:40:55 +0000 (UTC) X-Originating-IP: 71.196.232.122 Received: from localhost.localdomain (c-71-196-232-122.hsd1.co.comcast.net [71.196.232.122]) (Authenticated sender: jpettit@ovn.org) by relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 7F3BE41C07C for ; Sat, 23 Dec 2017 07:40:53 +0100 (CET) From: Justin Pettit To: dev@openvswitch.org Date: Fri, 22 Dec 2017 22:40:05 -0800 Message-Id: <1514011206-73894-1-git-send-email-jpettit@ovn.org> X-Mailer: git-send-email 2.7.4 X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW 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 1/2] ovsdb-server: Update description for "compact" command in man page. 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 man page indicated that multiple databases could be specified, but only one is allowed. Signed-off-by:Justin Pettit Acked-by: Ben Pfaff --- ovsdb/ovsdb-server.1.in | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ovsdb/ovsdb-server.1.in b/ovsdb/ovsdb-server.1.in index 870459e5d9ac..15ff77fd28aa 100644 --- a/ovsdb/ovsdb-server.1.in +++ b/ovsdb/ovsdb-server.1.in @@ -181,8 +181,8 @@ described below. These commands are specific to \fBovsdb\-server\fR. .IP "\fBexit\fR" Causes \fBovsdb\-server\fR to gracefully terminate. -.IP "\fBovsdb\-server/compact\fR [\fIdb\fR]\&..." -Compacts each database \fIdb\fR in-place. If no \fIdb\fR is +.IP "\fBovsdb\-server/compact\fR [\fIdb\fR]" +Compacts database \fIdb\fR in-place. If \fIdb\fR is not specified, compacts every database in-place. A database is also compacted automatically when a transaction is logged if it is over 4 times as large as its previous compacted size (and at least 10 MB), From patchwork Sat Dec 23 06:40:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Pettit X-Patchwork-Id: 852615 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 3z3bPh50nxz9s74 for ; Sat, 23 Dec 2017 17:41:28 +1100 (AEDT) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id D4F95C04; Sat, 23 Dec 2017 06:40:59 +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 B0EB4958 for ; Sat, 23 Dec 2017 06:40:56 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id D81EE3D9 for ; Sat, 23 Dec 2017 06:40:55 +0000 (UTC) X-Originating-IP: 71.196.232.122 Received: from localhost.localdomain (c-71-196-232-122.hsd1.co.comcast.net [71.196.232.122]) (Authenticated sender: jpettit@ovn.org) by relay5-d.mail.gandi.net (Postfix) with ESMTPSA id 5992741C080 for ; Sat, 23 Dec 2017 07:40:54 +0100 (CET) From: Justin Pettit To: dev@openvswitch.org Date: Fri, 22 Dec 2017 22:40:06 -0800 Message-Id: <1514011206-73894-2-git-send-email-jpettit@ovn.org> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1514011206-73894-1-git-send-email-jpettit@ovn.org> References: <1514011206-73894-1-git-send-email-jpettit@ovn.org> X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_LOW 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 2/2] ovsdb-client: Remove extraneous markup from man page. 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 Signed-off-by: Justin Pettit Acked-by: Ben Pfaff --- ovsdb/ovsdb-client.1.in | 68 ++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 34 deletions(-) diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in index 203d70cfac2d..5dbd49f25263 100644 --- a/ovsdb/ovsdb-client.1.in +++ b/ovsdb/ovsdb-client.1.in @@ -14,43 +14,43 @@ ovsdb\-client \- command-line interface to \fBovsdb-server\fR(1) . .SH SYNOPSIS .IP "Server-Level Commands:" -\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-dbs \fR[\fIserver\fR] +\fBovsdb\-client\fR [\fIoptions\fR] \fBlist\-dbs\fR [\fIserver\fR] .IP "Database Schema Commands:" -\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR] +\fBovsdb\-client\fR [\fIoptions\fR] \fBget\-schema\fR [\fIserver\fR] [\fIdatabase\fR] .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] +\fBovsdb\-client\fR [\fIoptions\fR] \fBlist\-tables\fR [\fIserver\fR] [\fIdatabase\fR] .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] [\fItable\fR] +\fBovsdb\-client\fR [\fIoptions\fR] \fBlist\-columns\fR [\fIserver\fR] [\fIdatabase\fR] [\fItable\fR] .IP "Database Version Management Commands:" .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] +\fBovsdb\-client\fR [\fIoptions\fR] \fBget\-schema\-version\fR [\fIserver\fR] [\fIdatabase\fR] .IP "Data Management Commands:" -\fBovsdb\-client \fR[\fIoptions\fR] \fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBtransact\fR [\fIserver\fR] \fItransaction\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBquery \fR[\fIserver\fR] \fItransaction\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBquery\fR [\fIserver\fR] \fItransaction\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR [\fItable\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBdump\fR [\fIserver\fR] [\fIdatabase\fR] [\fItable\fR [\fIcolumn\fR...]] .br -\fBovsdb\-client \fR[\fIoptions\fR] -\fBbackup \fR[\fIserver\fR] [\fIdatabase\fR] \fB> \fIsnapshot\fR +\fBovsdb\-client\fR [\fIoptions\fR] +\fBbackup\fR [\fIserver\fR] [\fIdatabase\fR] \fB> \fIsnapshot\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] [\fB\-\-force\fR] -\fBrestore \fR[\fIserver\fR] [\fIdatabase\fR] \fB< \fIsnapshot\fR +\fBovsdb\-client\fR [\fIoptions\fR] [\fB\-\-force\fR] +\fBrestore\fR [\fIserver\fR] [\fIdatabase\fR] \fB< \fIsnapshot\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBmonitor\fR [\fIserver\fR] [\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]... .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fBALL\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBmonitor\fR [\fIserver\fR] [\fIdatabase\fR] \fBALL\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBmonitor\-cond\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fIconditions +\fBovsdb\-client\fR [\fIoptions\fR] \fBmonitor\-cond\fR [\fIserver\fR] [\fIdatabase\fR] \fIconditions \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]... .IP "Testing Commands:" -\fBovsdb\-client \fR[\fIoptions\fR] \fBlock\fI \fR[\fIserver\fR] \fIlock\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBlock\fR [\fIserver\fR] \fIlock\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBsteal\fI \fR[\fIserver\fR] \fIlock\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBsteal\fR [\fIserver\fR] \fIlock\fR .br -\fBovsdb\-client \fR[\fIoptions\fR] \fBunlock\fI \fR[\fIserver\fR] \fIlock\fR +\fBovsdb\-client\fR [\fIoptions\fR] \fBunlock\fR [\fIserver\fR] \fIlock\fR .br .IP "Other Commands:" \fBovsdb\-client help\fR @@ -86,7 +86,7 @@ supports. Most \fBovsdb\-client\fR commands work with an individual database, but these commands apply to an entire database server. . -.IP "\fBlist\-dbs \fR[\fIserver\fR]" +.IP "\fBlist\-dbs\fR [\fIserver\fR]" Connects to \fIserver\fR, retrieves the list of known databases, and prints them one per line. These database names are the ones that other commands may use for \fIdatabase\fR. @@ -96,16 +96,16 @@ other commands may use for \fIdatabase\fR. These commands obtain the schema from a database and print it or part of it. . -.IP "\fBget\-schema \fR[\fIserver\fR] \fR[\fIdatabase\fR]" +.IP "\fBget\-schema\fR [\fIserver\fR] [\fIdatabase\fR]" Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and prints it in JSON format. . -.IP "\fBlist\-tables\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]" +.IP "\fBlist\-tables\fR [\fIserver\fR] [\fIdatabase\fR]" Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and prints a table listing the name of each table within the database. . -.IP "\fBlist\-columns\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR" +.IP "\fBlist\-columns\fR [\fIserver\fR] [\fIdatabase\fR] \fItable\fR" Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and prints a table listing the name and type of each column. If \fItable\fR is specified, only columns in that table are @@ -117,14 +117,14 @@ listed; otherwise, the tables include columns in all tables. These commands work with different versions of OVSDB schemas and databases. . -.IP "\fBget\-schema\-version\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]" +.IP "\fBget\-schema\-version\fR [\fIserver\fR] [\fIdatabase\fR]" Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and prints its version number on stdout. If \fIdatabase\fR was created before schema versioning was introduced, then it will not have a version number and this command will print a blank line. . -.IP "\fBget\-schema\-cksum\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]" +.IP "\fBget\-schema\-cksum\fR [\fIserver\fR] [\fIdatabase\fR]" Connects to \fIserver\fR, retrieves the schema for \fIdatabase\fR, and prints its checksum on stdout. If \fIdatabase\fR does not include a checksum, prints a blank line. @@ -133,13 +133,13 @@ checksum, prints a blank line. .PP These commands read or modify the data in a database. . -.IP "\fBtransact\fI \fR[\fIserver\fR] \fItransaction\fR" +.IP "\fBtransact\fR [\fIserver\fR] \fItransaction\fR" Connects to \fIserver\fR, sends it the specified \fItransaction\fR, which must be a JSON array appropriate for use as the \fBparams\fR to a JSON-RPC \fBtransact\fR request, and prints the received reply on stdout. . -.IP "\fBquery \fR[\fIserver\fR] \fItransaction\fR" +.IP "\fBquery\fR [\fIserver\fR] \fItransaction\fR" This commands acts like a read-only version of \fBtransact\fR. It connects to \fIserver\fR, sends it the specified \fItransaction\fR, which must be a JSON array appropriate for use as the \fBparams\fR to @@ -149,13 +149,13 @@ this command appends an \fBabort\fR operation to the set of operations included in \fItransaction\fR before sending it to the database, and then removes the \fBabort\fR result from the reply (if it is present). . -.IP "\fBdump\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR]\fR [\fItable \fR[\fIcolumn\fR...]]" +.IP "\fBdump\fR [\fIserver\fR] [\fIdatabase\fR] [\fItable\fR [\fIcolumn\fR...]]" Connects to \fIserver\fR, retrieves all of the data in \fIdatabase\fR, and prints it on stdout as a series of tables. If \fItable\fR is specified, only that table is retrieved. If at least one \fIcolumn\fR is specified, only those columns are retrieved. . -.IP "\fBbackup \fR[\fIserver\fR] [\fIdatabase\fR] \fB> \fIsnapshot\fR" +.IP "\fBbackup\fR [\fIserver\fR] [\fIdatabase\fR] \fB> \fIsnapshot\fR" Connects to \fIserver\fR, retrieves a snapshot of the schema and data in \fIdatabase\fR, and prints it on stdout in the format used for OVSDB database files. This is an appropriate @@ -170,7 +170,7 @@ database is in use. The output does not include ephemeral columns, which by design do not survive across restarts of \fBovsdb\-server\fR. . -.IP "[\fB\-\-force\fR] \fBrestore \fR[\fIserver\fR] [\fIdatabase\fR] \fB< \fIsnapshot\fR" +.IP "[\fB\-\-force\fR] \fBrestore\fR [\fIserver\fR] [\fIdatabase\fR] \fB< \fIsnapshot\fR" Reads \fIsnapshot\fR, which must be a OVSDB standalone or active-backup database (possibly but not necessarily created by \fBovsdb\-client backup). Then, connects to \fIserver\fR, verifies @@ -195,8 +195,8 @@ e.g. with \fBovsdb\-client convert\fR. Use \fB\-\-force\fR to proceed regardless of schema differences even though the restore might fail with an error or succeed with surprising results. . -.IP "\fBmonitor\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..." -.IQ "\fBmonitor\-cond\fI \fR[\fIserver\fR] \fR[\fIdatabase\fR] \fIconditions\fR \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..." +.IP "\fBmonitor\fR [\fIserver\fR] [\fIdatabase\fR] \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..." +.IQ "\fBmonitor\-cond\fR [\fIserver\fR] [\fIdatabase\fR] \fIconditions\fR \fItable\fR [\fIcolumn\fR[\fB,\fIcolumn\fR]...]..." Connects to \fIserver\fR and monitors the contents of rows that match conditions in \fItable\fR in \fIdatabase\fR. By default, the initial contents of \fItable\fR are printed, followed by each change as it occurs. If conditions empty, @@ -244,9 +244,9 @@ session with the server. These commands are mostly of interest for testing the correctness of the OVSDB server. . -.IP "\fBlock\fI \fR[\fIserver\fR] \fIlock\fR" -.IQ "\fBsteal\fI \fR[\fIserver\fR] \fIlock\fR" -.IQ "\fBunlock\fI \fR[\fIserver\fR] \fIlock\fR" +.IP "\fBlock\fR [\fIserver\fR] \fIlock\fR" +.IQ "\fBsteal\fR [\fIserver\fR] \fIlock\fR" +.IQ "\fBunlock\fR [\fIserver\fR] \fIlock\fR" Connects to \fIserver\fR and issues corresponding RFC 7047 lock operations on \fIlock\fR. Prints json reply or subsequent update messages. The \fB\-\-detach\fR option causes \fBovsdb\-client\fR to detach after it