From patchwork Tue Nov 22 18:18:57 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 697872 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 3tNYrx32qRz9svs for ; Wed, 23 Nov 2016 05:29:05 +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="Fkpo406D"; dkim-atps=neutral Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 37B58B59; Tue, 22 Nov 2016 18:21:51 +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 5B89FB59 for ; Tue, 22 Nov 2016 18:21:50 +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 BE8A81FE for ; Tue, 22 Nov 2016 18:21:46 +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 4B1E4E156F for ; Tue, 22 Nov 2016 18:21:42 +0000 (UTC) Received: from one.mxroute.com (ip-10-107-69-155.us-west-2.compute.internal [10.107.69.155]) by relay.mailchannels.net (Postfix) with ESMTPA id BD7C3E15F7 for ; Tue, 22 Nov 2016 18:21:38 +0000 (UTC) X-Sender-Id: mxroute|x-authuser|stephen@that.guru Received: from one.mxroute.com ([TEMPUNAVAIL]. [10.135.9.54]) (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:21:39 +0000 X-MC-Relay: Neutral X-MailChannels-SenderId: mxroute|x-authuser|stephen@that.guru X-MailChannels-Auth-Id: mxroute X-MC-Loop-Signature: 1479838898997:3117730130 X-MC-Ingress-Time: 1479838898996 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=jedTvvh6zKoIe+GjIFyt7wg+K9wBQMbWqrMm7DDky9A=; b=Fkpo406D6eiTFaJ4vfZ/2Qyltv crS/wLYIo7sjTdgS4UKz0H16cxAXOzgIEKnAdE9akRJANKdfYDv7xtjGfY0NqKmmmYHOrlJ1dr+Lr fyDSSmJO//MKqA80FYj/dnP37k31pcbQ/ifXdUcA41dehiuESoDyR/TR1XffGJyfg9V0TjUEnVf1+ M/LDBV2YcihI7PNBpD+QuOrafdSf3hSc7I8WKQzDc0eZnwvS8dlYIzzdIdbSHDtNTCE1+hPbsZY4Y w/wv0TMHInqFtIKx1zVwPyejCMxAtpkHY0EbAt/mM5C3iMwdVfF0SlrdnuTLYaaQA5DorPqhHs3yu zeGAw2Ew==; From: Stephen Finucane To: dev@openvswitch.org Date: Tue, 22 Nov 2016 18:18:57 +0000 Message-Id: <1479838739-26356-13-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 12/14] doc: Move WHY-OVS 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 moved separately due to the sheer number of references to this file in the codebase. Signed-off-by: Stephen Finucane --- Documentation/automake.mk | 1 + Documentation/intro/index.rst | 1 + WHY-OVS.rst => Documentation/intro/why-ovs.rst | 0 FAQ.rst | 6 +++--- Makefile.am | 3 +-- rhel/openvswitch-fedora.spec.in | 2 +- rhel/openvswitch.spec.in | 2 +- tests/run-oftest | 2 +- tests/run-ryu | 2 +- tutorial/ovs-sandbox | 2 +- utilities/ovs-dev.py | 2 +- utilities/ovs-sim.in | 4 ++-- 12 files changed, 14 insertions(+), 13 deletions(-) rename WHY-OVS.rst => Documentation/intro/why-ovs.rst (100%) diff --git a/Documentation/automake.mk b/Documentation/automake.mk index 1f9800f..decea3c 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -7,6 +7,7 @@ EXTRA_DIST += \ Documentation/index.rst \ Documentation/contents.rst \ Documentation/intro/index.rst \ + Documentation/intro/why-ovs.rst \ Documentation/intro/install/index.rst \ Documentation/intro/install/bash-completion.rst \ Documentation/intro/install/debian.rst \ diff --git a/Documentation/intro/index.rst b/Documentation/intro/index.rst index 7d42813..7ad8bf3 100644 --- a/Documentation/intro/index.rst +++ b/Documentation/intro/index.rst @@ -32,4 +32,5 @@ How to get started with Open vSwitch. .. toctree:: :maxdepth: 2 + why-ovs install/index diff --git a/WHY-OVS.rst b/Documentation/intro/why-ovs.rst similarity index 100% rename from WHY-OVS.rst rename to Documentation/intro/why-ovs.rst diff --git a/FAQ.rst b/FAQ.rst index aa21d91..83f6c59 100644 --- a/FAQ.rst +++ b/FAQ.rst @@ -87,9 +87,9 @@ Q: Why would I use Open vSwitch instead of the Linux bridge? A: Open vSwitch is specially designed to make it easier to manage VM network configuration and monitor state spread across many physical hosts - in dynamic virtualized environments. Refer to `WHY-OVS `__ - for a more detailed description of how Open vSwitch relates to the Linux - Bridge. + in dynamic virtualized environments. Refer to `WHY-OVS + `__ for a more detailed description of how + Open vSwitch relates to the Linux Bridge. Q: How is Open vSwitch related to distributed virtual switches like the VMware vNetwork distributed switch or the Cisco Nexus 1000V? diff --git a/Makefile.am b/Makefile.am index 0397654..0e05c05 100644 --- a/Makefile.am +++ b/Makefile.am @@ -69,8 +69,7 @@ docs = \ CONTRIBUTING.rst \ FAQ.rst \ MAINTAINERS.rst \ - README.rst \ - WHY-OVS.rst + README.rst EXTRA_DIST = \ $(docs) \ NOTICE \ diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in index d9befe0..c71c12f 100644 --- a/rhel/openvswitch-fedora.spec.in +++ b/rhel/openvswitch-fedora.spec.in @@ -481,7 +481,7 @@ fi %{_mandir}/man8/ovs-vswitchd.8* %{_mandir}/man8/ovs-parse-backtrace.8* %{_mandir}/man8/ovs-testcontroller.8* -%doc COPYING NOTICE README.rst WHY-OVS.rst +%doc COPYING NOTICE README.rst %doc FAQ.rst NEWS rhel/README.RHEL.rst /var/lib/openvswitch /var/log/openvswitch diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in index 7ed948b..5d83ec0 100644 --- a/rhel/openvswitch.spec.in +++ b/rhel/openvswitch.spec.in @@ -248,7 +248,7 @@ exit 0 /usr/share/openvswitch/scripts/sysconfig.template /usr/share/openvswitch/vswitch.ovsschema /usr/share/openvswitch/vtep.ovsschema -%doc COPYING NOTICE README.rst WHY-OVS.rst FAQ.rst NEWS +%doc COPYING NOTICE README.rst FAQ.rst NEWS %doc rhel/README.RHEL.rst /var/lib/openvswitch /var/log/openvswitch diff --git a/tests/run-oftest b/tests/run-oftest index ecfd783..d5701d6 100755 --- a/tests/run-oftest +++ b/tests/run-oftest @@ -21,7 +21,7 @@ case $srcdir in /*) ;; *) srcdir=`pwd`/$srcdir ;; esac -if test ! -e "$srcdir"/WHY-OVS.rst; then +if test ! -e "$srcdir"/README.rst; then echo >&2 'source directory not found, please set $srcdir or run via \"make check-oftest' exit 1 fi diff --git a/tests/run-ryu b/tests/run-ryu index 0be6c01..2aea14d 100755 --- a/tests/run-ryu +++ b/tests/run-ryu @@ -19,7 +19,7 @@ case $srcdir in /*) ;; *) srcdir=`pwd`/$srcdir ;; esac -if test ! -e "$srcdir"/WHY-OVS.rst; then +if test ! -e "$srcdir"/README.rst; then echo >&2 'source directory not found, please set $srcdir or run via \"make check-ryu' exit 1 fi diff --git a/tutorial/ovs-sandbox b/tutorial/ovs-sandbox index 4372da4..c9742ab 100755 --- a/tutorial/ovs-sandbox +++ b/tutorial/ovs-sandbox @@ -223,7 +223,7 @@ if $built; then case $srcdir in '') srcdir=$builddir - if test ! -e "$srcdir"/WHY-OVS.rst; then + if test ! -e "$srcdir"/README.rst; then srcdir=`cd $builddir/.. && pwd` fi ;; diff --git a/utilities/ovs-dev.py b/utilities/ovs-dev.py index 9188d73..a3a7f56 100755 --- a/utilities/ovs-dev.py +++ b/utilities/ovs-dev.py @@ -24,7 +24,7 @@ ENV = os.environ HOME = ENV["HOME"] PWD = os.getcwd() OVS_SRC = HOME + "/ovs" -if os.path.exists(PWD + "/WHY-OVS.rst"): +if os.path.exists(PWD + "/README.rst"): OVS_SRC = PWD # Use current directory as OVS source tree RUNDIR = OVS_SRC + "/_run" BUILD_GCC = OVS_SRC + "/_build-gcc" diff --git a/utilities/ovs-sim.in b/utilities/ovs-sim.in index 3f31b25..3932974 100755 --- a/utilities/ovs-sim.in +++ b/utilities/ovs-sim.in @@ -63,8 +63,8 @@ if test ! -e "$sim_builddir"/vswitchd/ovs-vswitchd; then echo "$sim_builddir/vswitchd/ovs-vswitchd does not exist (need to run \"make\"?)" >&2 exit 1 fi -if test ! -e "$sim_srcdir"/WHY-OVS.rst; then - echo "$sim_srcdir/WHY-OVS.rst does not exist" >&2 +if test ! -e "$sim_srcdir"/README.rst; then + echo "$sim_srcdir/README.rst does not exist" >&2 exit 1 fi