From patchwork Sat Dec 17 22:23:40 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 706730 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org 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 3th1w736X7z9vFF for ; Sun, 18 Dec 2016 09:25:27 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="db5hI+IZ"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 711A3955; Sat, 17 Dec 2016 22:24:05 +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 98A5F4A5 for ; Sat, 17 Dec 2016 22:24:03 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from brown.birch.relay.mailchannels.net (brown.birch.relay.mailchannels.net [23.83.209.23]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 35FFB14B for ; Sat, 17 Dec 2016 22:24:03 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 65EE6E0A9C for ; Sat, 17 Dec 2016 22:24:02 +0000 (UTC) Received: from one.mxroute.com (ip-10-220-3-24.us-west-2.compute.internal [10.220.3.24]) by relay.mailchannels.net (Postfix) with ESMTPA id E2C5CE130D for ; Sat, 17 Dec 2016 22:24:01 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([TEMPUNAVAIL]. [10.90.135.124]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Sat, 17 Dec 2016 22:24:02 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1482013442127:2989415404 X-MC-Ingress-Time: 1482013442126 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=5YuCNU1lJGKEHP6vin8jN+OK+Z09c//VSbAdH1gAsnE=; b=db5hI+IZBZI7wBM7ESiAxlZ3+8 faYLc/g6gPLc99OYgn2J8sTkMXoEoqFyBaOROHyuPhJhmBRWitflLpn6vb2taxe3leMTRswkJ3cRE uAmHi7Mvl8c091UyfnZTk9hncHnq5VOjMWCP5XgJm+bjhBP+ej0SRxhefwXPjrcyLl+Kd4+4k0rN0 0d1tROvIE8tlEei7YGS5gS4QNTImFRf0kGGaVxGerUS482qtPSy2uNIzNSJrEtYwXYs39/zQ0l4P9 NKMSmP1mSsWBazDWO7Gp6Hl2Q6bx6IYKFuQRSMxx1j9iVtKouTgfdYgieSlh9sR0AcwC9eO9s30dK knACKNHg==; From: Stephen Finucane To: dev@openvswitch.org Date: Sat, 17 Dec 2016 22:23:40 +0000 Message-Id: <20161217222342.21653-4-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161217222342.21653-1-stephen@that.guru> References: <20161217222342.21653-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-Spam-Status: No, score=-1.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_NONE,T_DKIM_INVALID autolearn=no version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on smtp1.linux-foundation.org Subject: [ovs-dev] [PATCH 4/6] doc: Misc fixes to 'bash-completion' 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 Fix some minor formatting issues with this document. Signed-off-by: Stephen Finucane --- Documentation/intro/install/bash-completion.rst | 27 ++++++++++--------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/Documentation/intro/install/bash-completion.rst b/Documentation/intro/install/bash-completion.rst index 6df60c6..4018be0 100644 --- a/Documentation/intro/install/bash-completion.rst +++ b/Documentation/intro/install/bash-completion.rst @@ -25,14 +25,14 @@ Bash command-line completion scripts ==================================== -There are two completion scripts available, ovs-appctl-bashcomp.bash and -ovs-vsctl-bashcomp.bash respectively. +There are two completion scripts available: ``ovs-appctl-bashcomp.bash`` and +``ovs-vsctl-bashcomp.bash``. ovs-appctl-bashcomp ------------------- -ovs-appctl-bashcomp.bash adds bash command-line completion support for -ovs-appctl, ovs-dpctl, ovs-ofctl and ovsdb-tool commands. +``ovs-appctl-bashcomp.bash`` adds bash command-line completion support for +``ovs-appctl``, ``ovs-dpctl``, ``ovs-ofctl`` and ``ovsdb-tool`` commands. Features ~~~~~~~~ @@ -48,19 +48,14 @@ Features Limitations ~~~~~~~~~~~ -- Only supports a small set of important keywords (``dp``, ``datapath``, ``bridge``, ``switch``, - ``port``, ``interface``, ``iface``). +- Only supports a small set of important keywords (``dp``, ``datapath``, + ``bridge``, ``switch``, ``port``, ``interface``, ``iface``). -- Does not support parsing of nested options. For example: - - - :: +- Does not support parsing of nested options. For example:: $ ovsdb-tool create [db [schema]] -- Does not support expansion on repeated argument. For example: - - :: +- Does not support expansion on repeated argument. For example:: $ ovs-dpctl show [dp...]). @@ -70,8 +65,8 @@ Limitations ovs-vsctl-bashcomp ------------------- -ovs-vsctl-bashcomp.bash adds bash command-line completion support for ovs-vsctl -command. +``ovs-vsctl-bashcomp.bash`` adds Bash command-line completion support for +``ovs-vsctl`` command. Features ~~~~~~~~ @@ -84,7 +79,7 @@ Features - Deal with argument relations like 'one and more', 'zero or one'. -- Complete multiple ovs-vsctl commands cascaded via ``--``. +- Complete multiple ``ovs-vsctl`` commands cascaded via ``--``. Limitations ~~~~~~~~~~~