From patchwork Thu Dec 8 12:55:22 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 704062 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 3tZFnQ0Stsz9vDV for ; Thu, 8 Dec 2016 23:59:38 +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="VzXhqZoQ"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 98176BD6; Thu, 8 Dec 2016 12:55: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 BF812BAE for ; Thu, 8 Dec 2016 12:55:57 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from nov-007-i609.relay.mailchannels.net (nov-007-i609.relay.mailchannels.net [46.232.183.163]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 4CB27189 for ; Thu, 8 Dec 2016 12:55:53 +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 A5D8F22170 for ; Thu, 8 Dec 2016 12:55:43 +0000 (UTC) Received: from one.mxroute.com (ip-10-120-4-226.us-west-2.compute.internal [10.120.4.226]) by relay.mailchannels.net (Postfix) with ESMTPA id 0E91822B5B for ; Thu, 8 Dec 2016 12:55:42 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.107.128.240]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Thu, 08 Dec 2016 12:55:43 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1481201743405:766720917 X-MC-Ingress-Time: 1481201743405 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=Pu2YtLMhlNjIhOmqqUhEyrebk2GC1clYC/m5r2a9p1o=; b=VzXhqZoQNvs0KKOjsEQJeWmi/c mVC83OvX4ilHKdVSjDzWne93S8wSEmhx5Ho8iENsKRZdA7EeIRkAJKdkfHllBIYO19otV5ssdI7CH UYNCe5NvfExu2h+D+6BmRwWy4W1gEt9K5ZK0RU4ZPsDqkFmyRKp1z9G1/DzPGE73QHC53rRMRQfQA b/B0M58Rpx3qDi/mggaJiMqyq/Ak54w3p+Oj3CK0uKmXxU8fCVIXbcF3rsTh+ky21xSU6/zeM2Kom 5uXuPGMxhKuqzXaKzRM97yrkQyvU9fPUdbnhWoXRXVpXghLnPlKRdugVEidfGcUHt2JULRkpCquYc Ib3KwfeA==; From: Stephen Finucane To: dev@openvswitch.org Date: Thu, 8 Dec 2016 12:55:22 +0000 Message-Id: <20161208125530.17283-4-stephen@that.guru> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20161208125530.17283-1-stephen@that.guru> References: <20161208125530.17283-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 v2 03/11] doc: Populate 'ref' section 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 This is a simple table with links to the manpages published on openvswitch.org. Something fancier can be done in the future. Signed-off-by: Stephen Finucane --- Documentation/ref/index.rst | 144 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 143 insertions(+), 1 deletion(-) diff --git a/Documentation/ref/index.rst b/Documentation/ref/index.rst index cb4f30b..27d975a 100644 --- a/Documentation/ref/index.rst +++ b/Documentation/ref/index.rst @@ -30,4 +30,146 @@ Reference Guide Man Pages --------- -**TODO** +.. TODO(stephenfin): Investigate some way to get the manpages into rST format. + The most viable option seems to be writing them all in rST, converting them + to roff format and storing both the rST and roff formatted docs in version + control. + +.. list-table:: + + * - ovn-architecture(7) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-controller(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-controller-vtep(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-ctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-nb(5) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-nbctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-northd(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-sb(5) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-sbctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovn-trace(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-appctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-bugtool(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-ctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovsdb-client(1) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovsdb-server(1) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovsdb-tool(1) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-dpctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-dpctl-top(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-l3ping(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-ofctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-parse-backtrace(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-pcap(1) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-pki(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-tcpdump(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-tcpundump(1) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-test(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-testcontroller(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-vlan-bug-workaround(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-vlan-test(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-vsctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-vswitchd(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - ovs-vswitchd.conf.db(5) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - vtep(5) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ + * - vtep-ctl(8) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__