From patchwork Tue Nov 22 18:18:51 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 697864 X-Patchwork-Delegate: rbryant@redhat.com 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 3tNYmR288Jz9t2D for ; Wed, 23 Nov 2016 05:25:11 +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="I5nSdLKk"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 0F799BA4; Tue, 22 Nov 2016 18:20:19 +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 C0421B2E for ; Tue, 22 Nov 2016 18:20:16 +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 5B33A1F5 for ; Tue, 22 Nov 2016 18:20:13 +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 4BB051000C6 for ; Tue, 22 Nov 2016 18:20:09 +0000 (UTC) Received: from one.mxroute.com (ip-10-229-2-62.us-west-2.compute.internal [10.229.2.62]) by relay.mailchannels.net (Postfix) with ESMTPA id 99EBC10278D for ; Tue, 22 Nov 2016 18:20:08 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([UNAVAILABLE]. [10.88.26.109]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384) by 0.0.0.0:2500 (trex/5.7.8); Tue, 22 Nov 2016 18:20:09 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1479838808976:37808288 X-MC-Ingress-Time: 1479838808975 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=fKJe3nqX1ZePsEytKuE2yIYK3Y0XvzISQy30l9IksgI=; b=I5nSdLKk/6ADuynbCdkkuUGM+2 gbyQMlXo30vKQYNpKV85Ex89LZEneow0oDfSLGscdjAZHTziAnPhyX7oclZQzbzt2Qrpvvp2snyp2 2izCxLKy1KlHP5mJRqsllIII8M9AG0bX/esPrUwZ0rqP4cjZzqtc+pimX92XD60c1FAYxGXYWhEbI Kx3OLGEhhKu+7H8KIlx3jvUyjXQg4vXMymnPCKqjtlsfTVDI4K2TcWk85+NifoTUwL/RKTYT7Ky/v fEwrauJsEVbG+1eI8boqqN8j+NNIoZIImx2xZnaUMxKBwn+RhQ2/91whdN4YljMEvjg+1TvLKXgWq fO66pgMQ==; From: Stephen Finucane To: dev@openvswitch.org Date: Tue, 22 Nov 2016 18:18:51 +0000 Message-Id: <1479838739-26356-7-git-send-email-stephen@that.guru> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1479838739-26356-1-git-send-email-stephen@that.guru> References: <1479838739-26356-1-git-send-email-stephen@that.guru> X-OutGoing-Spam-Status: No, score=-10.0 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 06/14] 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) `__