From patchwork Thu Feb 2 07:02:34 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Russell Bryant X-Patchwork-Id: 722848 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 3vDWCk36Znz9s7C for ; Thu, 2 Feb 2017 18:02:42 +1100 (AEDT) Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 83C2FB75; Thu, 2 Feb 2017 07:02:39 +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 7E334B6E for ; Thu, 2 Feb 2017 07:02:37 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id E35FFA4 for ; Thu, 2 Feb 2017 07:02:36 +0000 (UTC) Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 61657C054902; Thu, 2 Feb 2017 07:02:37 +0000 (UTC) Received: from t460s.redhat.com (ovpn-120-19.rdu2.redhat.com [10.10.120.19] (may be forged)) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id v1272aar017492; Thu, 2 Feb 2017 02:02:36 -0500 From: Russell Bryant To: dev@openvswitch.org Date: Thu, 2 Feb 2017 02:02:34 -0500 Message-Id: <20170202070234.14750-1-russell@ovn.org> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.27 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Thu, 02 Feb 2017 07:02:37 +0000 (UTC) X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_HI 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] docs: Add OVS and OVN headings to pages. 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 Update the "deep dive" and "howto" pages with headings that more clearly indicate the separate lists of OVS or OVN content. Also add a link to ovn-architecture from the "deep dive" page as it seems quite relevant there. Signed-off-by: Russell Bryant Acked-by: Ben Pfaff --- Documentation/howto/index.rst | 6 ++++++ Documentation/topics/index.rst | 23 ++++++++++++++++++----- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst index 2d37300..5859a33 100644 --- a/Documentation/howto/index.rst +++ b/Documentation/howto/index.rst @@ -30,6 +30,9 @@ How-to Guides Answers to common "How do I?"-style questions. For more information on the topics covered herein, refer to :doc:`/topics/index`. +OVS +--- + .. toctree:: :maxdepth: 2 @@ -46,6 +49,9 @@ topics covered herein, refer to :doc:`/topics/index`. sflow dpdk +OVN +--- + .. toctree:: :maxdepth: 1 diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst index 28ee04e..fd42414 100644 --- a/Documentation/topics/index.rst +++ b/Documentation/topics/index.rst @@ -23,12 +23,15 @@ Avoid deeper levels because they do not render well. -====================== -Open vSwitch Deep Dive -====================== +========= +Deep Dive +========= -How Open vSwitch is implemented and, where necessary, why it was implemented -that way. +How Open vSwitch and OVN are implemented and, where necessary, why it was +implemented that way. + +OVS +--- .. toctree:: :maxdepth: 2 @@ -45,7 +48,17 @@ that way. language-bindings testing +OVN +--- + .. toctree:: :maxdepth: 2 high-availability + +.. list-table:: + + * - ovn-architecture(7) + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__