doc: Add more cross references between docs

Suggested-by: Lori Jakab <[email protected]>
Signed-off-by: Thomas Graf <[email protected]>
Reviewed-by: Flavio Leitner <[email protected]>
Signed-off-by: Ben Pfaff <[email protected]>

CONTRIBUTING.md

@@ -44,8 +44,8 @@ Testing is also important:
 If you are using GitHub, then you may utilize the travis-ci.org CI build
 system by linking your GitHub repository to it. This will run some of
 the above tests automatically when you push changes to your repository.
-See the "Continuous Integration with Travis-CI" in the [INSTALL](INSTALL.md)
-file for details on how to set it up.
+See the "Continuous Integration with Travis-CI" in the [INSTALL.md] file
+for details on how to set it up.
 
 Email Subject
 -------------
@@ -278,8 +278,8 @@ If you cannot convince your email client not to mangle patches, then
 sending the patch as an attachment is a second choice.
 
 Please follow the style used in the code that you are modifying.  The
-[CodingStyle](CodingStyle.md) file describes the coding style used in
-most of Open vSwitch. Use Linux kernel coding style for Linux kernel code.
+[CodingStyle.md] file describes the coding style used in most of Open
+vSwitch. Use Linux kernel coding style for Linux kernel code.
 
 Example
 -------
@@ -316,3 +316,5 @@ index fdd952e..f6cb88e 100644
 1.7.7.3
 ```
 
+[INSTALL.md]:INSTALL.md
+[CodingStyle.md]:CodingStyle.md

FAQ.md

@@ -61,16 +61,16 @@ A: No, Open vSwitch has been ported to a number of different operating
 
 ### Q: What's involved with porting Open vSwitch to a new platform or switching ASIC?
 
-A: The [PORTING](PORTING.md) document describes how one would go about
+A: The [PORTING.md] document describes how one would go about
    porting Open vSwitch to a new operating system or hardware platform.
 
 ### 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.  Please see
-   [WHY-OVS](WHY-OVS.md) for a more detailed description of how Open
-   vSwitch relates to the Linux Bridge.
+   [WHY-OVS.md] 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?
 
@@ -690,7 +690,7 @@ A: On Linux kernels before 3.11, the OVS GRE module and Linux GRE module
    dmesg for errors regarding GRE registration). To fix this, unload all
    GRE modules that appear in lsmod as well as the OVS kernel module. You
    can then reload the OVS module following the directions in
-   [INSTALL](INSTALL.md), which will ensure that dependencies are satisfied.
+   [INSTALL.md], which will ensure that dependencies are satisfied.
 
 ### Q: Open vSwitch does not seem to obey my packet filter rules.
 
@@ -1237,7 +1237,7 @@ A: The following table lists the versions of OpenFlow supported by
    (Open vSwitch 2.2 had an experimental implementation of OpenFlow
    1.4 that could cause crashes.  We don't recommend enabling it.)
 
-   OPENFLOW-1.1+ in the Open vSwitch source tree tracks support for
+   [OPENFLOW-1.1+.md] in the Open vSwitch source tree tracks support for
    OpenFlow 1.1 and later features.  When support for OpenFlow 1.4 and
    1.5 is solidly implemented, Open vSwitch will enable those version
    by default.  Also, the OpenFlow 1.5 specification is still under
@@ -1630,8 +1630,7 @@ A: Add your new message to "enum ofpraw" and "enum ofptype" in
    lib/ofp-msgs.h, following the existing pattern.  Then recompile and
    fix all of the new warnings, implementing new functionality for the
    new message as needed.  (If you configure with --enable-Werror, as
-   described in [INSTALL](INSTALL.md), then it is impossible to miss
-   any warnings.)
+   described in [INSTALL.md], then it is impossible to miss any warnings.)
 
    If you need to add an OpenFlow vendor extension message for a
    vendor that doesn't yet have any extension messages, then you will
@@ -1643,3 +1642,8 @@ Contact
 
 [email protected]
 http://openvswitch.org/
+
+[PORTING.md]:PORTING.md
+[WHY-OVS.md]:WHY-OVS.md
+[INSTALL.md]:INSTALL.md
+[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md

INSTALL.DPDK.md

@@ -70,8 +70,7 @@ machines. Instead of typing `make`, type:
 
 `make CFLAGS='-O3 -march=native'`
 
-Refer to [INSTALL.userspace](INSTALL.userspace.md) for general requirements of
-building userspace OVS.
+Refer to [INSTALL.userspace.md] for general requirements of building userspace OVS.
 
 Using the DPDK with ovs-vswitchd:
 ---------------------------------
@@ -92,7 +91,7 @@ Using the DPDK with ovs-vswitchd:
 
    Ref to http://www.dpdk.org/doc/quick-start for verifying DPDK setup.
 
-4. Start ovsdb-server as discussed in [INSTALL](INSTALL.md) doc:
+4. Start ovsdb-server as discussed in [INSTALL.md] doc:
    1. First time only db creation (or clearing):
 
         ```
@@ -282,3 +281,6 @@ Bug Reporting:
 --------------
 
 Please report problems to [email protected].
+
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[INSTALL.md]:INSTALL.md

INSTALL.Debian.md

@@ -3,7 +3,7 @@ How to Build Debian Packages for Open vSwitch
 
 This document describes how to build Debian packages for Open vSwitch.
 To install Open vSwitch on Debian without building Debian packages,
-see [INSTALL](INSTALL.md) instead.
+see [INSTALL.md] instead.
 
 These instructions should also work on Ubuntu and other Debian
 derivative distributions.
@@ -89,3 +89,4 @@ Bug Reporting
 
 Please report problems to [email protected].
 
+[INSTALL.md]:INSTALL.md

INSTALL.Docker.md

@@ -2,10 +2,10 @@ How to Use Open vSwitch with Docker
 ====================================
 
 This document describes how to use Open vSwitch with Docker 1.2.0 or
-later.  This document assumes that you followed [INSTALL](INSTALL.md)
-or installed Open vSwitch from distribution packaging such as a .deb
-or .rpm.  Consult www.docker.com for instructions on how to install
-Docker.
+later.  This document assumes that you followed [INSTALL.md] or installed
+Open vSwitch from distribution packaging such as a .deb or .rpm.  Consult
+www.docker.com for instructions on how to install or .rpm.  Consult
+www.docker.com for instructions on how to install Docker.
 
 Limitations
 -----------
@@ -87,3 +87,5 @@ Bug Reporting
 -------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.Fedora.md

@@ -3,7 +3,7 @@ How to Install Open vSwitch on Fedora Linux
 
 This document describes how to build and install Open vSwitch on a Fedora
 Linux host.  If you want to install Open vSwitch on a generic Linux host,
-see [INSTALL.Linux](INSTALL.Linux.md) instead.
+see [INSTALL.md] instead.
 
 We have tested these instructions with Fedora 16 and Fedora 17.
 
@@ -87,3 +87,5 @@ Reporting Bugs
 --------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.KVM.md

@@ -3,14 +3,13 @@ How to Use Open vSwitch with KVM
 
 This document describes how to use Open vSwitch with the Kernel-based
 Virtual Machine (KVM). This document assumes that you have read and
-followed [INSTALL](INSTALL.md) to get Open vSwitch setup on your Linux
-system.
+followed [INSTALL.md] to get Open vSwitch setup on your Linux system.
 
 Setup
 -----
 
-First, follow the setup instructions in [INSTALL](INSTALL.md) to get a
-working Open vSwitch installation.
+First, follow the setup instructions in [INSTALL.md] to get a working
+Open vSwitch installation.
 
 KVM uses tunctl to handle various bridging modes, which you can 
 install with the Debian/Ubuntu package uml-utilities.
@@ -46,7 +45,7 @@ switch='br0'
 ovs-vsctl del-port ${switch} $1
 ```
 
-At the end of [INSTALL](INSTALL.md), it describes basic usage of creating
+At the end of [INSTALL.md], it describes basic usage of creating
 bridges and ports. If you haven't already, create a bridge named
 br0 with the following command:
 
@@ -84,3 +83,5 @@ Bug Reporting
 -------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.Libvirt.md

@@ -2,8 +2,8 @@ How to Use Open vSwitch with Libvirt
 ====================================
 
 This document describes how to use Open vSwitch with Libvirt 0.9.11 or
-later. This document assumes that you followed INSTALL or installed
-Open vSwitch from distribution packaging such as a .deb or .rpm. The Open
+later. This document assumes that you followed [INSTALL.md] or installed
+Open vSwitch from distribution packaging such as a .deb or .rpm.  The Open
 vSwitch support is included by default in Libvirt 0.9.11. Consult
 www.libvirt.org for instructions on how to build the latest Libvirt, if your
 Linux distribution by default comes with an older Libvirt release.
@@ -68,3 +68,5 @@ Bug Reporting
 -------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.NetBSD.md

@@ -11,7 +11,7 @@ In that case, you need at least the following packages.
   * py27-xml
   * pkg_alternatives
 
-Some components have additional requirements. (See [INSTALL](INSTALL.md))
+Some components have additional requirements. (See [INSTALL.md])
 
 Assuming you are running NetBSD/amd64 6.1.2, you can download and
 install pre-built binary packages as the following.
@@ -30,4 +30,8 @@ As all executables installed with pkgsrc are placed in `/usr/pkg/bin/`
 directory, it might be a good idea to add it to your PATH.
 
 Open vSwitch on NetBSD is currently "userspace switch" implementation
-in the sense described in INSTALL.userspace and PORTING.
+in the sense described in [INSTALL.userspace.md] and [PORTING.md].
+
+[INSTALL.md]:INSTALL.md
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[PORTING.md]:PORTING.md

INSTALL.RHEL.md

@@ -3,7 +3,7 @@ How to Install Open vSwitch on Red Hat Enterprise Linux
 
 This document describes how to build and install Open vSwitch on a Red
 Hat Enterprise Linux (RHEL) host.  If you want to install Open vSwitch
-on a generic Linux host, see [INSTALL](INSTALL.md) instead.
+on a generic Linux host, see [INSTALL.md] instead.
 
 We have tested these instructions with RHEL 5.6 and RHEL 6.0.
 
@@ -51,8 +51,8 @@ $HOME/rpmbuild/SOURCES.
      b. Create a distribution tarball on some other machine, by
         running "./boot.sh; ./configure; make dist" in the Git tree.
         You must run this on a machine that has the tools listed in
-        [INSTALL](INSTALL.md) as prerequisites for building from a Git
-		tree. Afterward, proceed with the rest of the instructions using
+        [INSTALL.md] as prerequisites for building from a Git tree.
+        Afterward, proceed with the rest of the instructions using
 		the distribution tarball.
 
 3. Some versions of the RHEL 6 kernel-devel package contain a broken
@@ -153,11 +153,14 @@ Red Hat Network Scripts Integration
 -----------------------------------
 
 Simple integration with Red Hat network scripts has been implemented.
-Please read rhel/README.RHEL in the source tree or
+Please read [rhel/README.RHEL] in the source tree or
 /usr/share/doc/openvswitch/README.RHEL in the installed openvswitch
 package for details.
 
 Reporting Bugs
 --------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md
+[rhel/README.RHEL]:rhel/README.RHEL

INSTALL.SSL.md

@@ -7,8 +7,8 @@ with OpenSSL.  SSL support ensures integrity and confidentiality of
 the OpenFlow connections, increasing network security.
 
 This file explains how to configure an Open vSwitch to connect to an
-OpenFlow controller over SSL.  Refer to INSTALL for instructions on
-building Open vSwitch with SSL support.
+OpenFlow controller over SSL.  Refer to [INSTALL.md] for instructions
+on building Open vSwitch with SSL support.
 
 Open vSwitch uses TLS version 1.0 or later (TLSv1), as specified by
 RFC 2246, which is very similar to SSL version 3.0.  TLSv1 was
@@ -310,3 +310,5 @@ Reporting Bugs
 --------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.XenServer.md

@@ -3,7 +3,7 @@ How to Install Open vSwitch on Citrix XenServer
 
 This document describes how to build and install Open vSwitch on a
 Citrix XenServer host.  If you want to install Open vSwitch on a
-generic Linux or BSD host, see [INSTALL](INSTALL.md) instead.
+generic Linux or BSD host, see [INSTALL.md] instead.
 
 These instructions have been tested with XenServer 5.6 FP1.
 
@@ -19,8 +19,8 @@ RPMs for Citrix XenServer is the DDK VM available from Citrix.
    ./configure; make dist` in the Git tree.  You cannot run this in
    the DDK VM, because it lacks tools that are necessary to bootstrap
    the Open vSwitch distribution.  Instead, you must run this on a
-   machine that has the tools listed in [INSTALL](INSTALL.md) as
-   prerequisites for building from a Git tree.
+   machine that has the tools listed in [INSTALL.md] as prerequisites
+   for building from a Git tree.
 
 2. Copy the distribution tarball into /usr/src/redhat/SOURCES inside
    the DDK VM.
@@ -190,3 +190,5 @@ Reporting Bugs
 --------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md

INSTALL.md

@@ -5,12 +5,12 @@ This document describes how to build and install Open vSwitch on a
 generic Linux, FreeBSD, or NetBSD host. For specifics around installation
 on a specific platform, please see one of these files:
 
-  - [INSTALL.Debian](INSTALL.Debian.md)
-  - [INSTALL.Fedora](INSTALL.Fedora.md)
-  - [INSTALL.RHEL](INSTALL.RHEL.md)
-  - [INSTALL.XenServer](INSTALL.XenServer.md)
-  - [INSTALL.NetBSD](INSTALL.NetBSD.md)
-  - [INSTALL.DPDK](INSTALL.DPDK.md)
+  - [INSTALL.Debian.md]
+  - [INSTALL.Fedora.md]
+  - [INSTALL.RHEL.md]
+  - [INSTALL.XenServer.md]
+  - [INSTALL.NetBSD.md]
+  - [INSTALL.DPDK.md]
 
 Build Requirements
 ------------------
@@ -43,15 +43,15 @@ you will need the following software:
 
 On Linux, you may choose to compile the kernel module that comes with
 the Open vSwitch distribution or to use the kernel module built into
-the Linux kernel (version 3.3 or later).  See the FAQ question "What
-features are not available in the Open vSwitch kernel datapath that
+the Linux kernel (version 3.3 or later).  See the [FAQ.md] question
+"What features are not available in the Open vSwitch kernel datapath that
 ships as part of the upstream Linux kernel?" for more information on
 this trade-off.  You may also use the userspace-only implementation,
-at some cost in features and performance (see INSTALL.userspace for
-details).  To compile the kernel module on Linux, you must also
+at some cost in features and performance (see [INSTALL.userspace.md]
+for details).  To compile the kernel module on Linux, you must also
 install the following:
 
-  - A supported Linux kernel version.  Please refer to README.md for a
+  - A supported Linux kernel version.  Please refer to [README.md] for a
     list of supported versions.
 
     The Open vSwitch datapath requires bridging support
@@ -184,7 +184,7 @@ Prerequisites section, follow the procedure below to build.
 
    If --with-linux requests building for an unsupported version of
    Linux, then "configure" will fail with an error message.  Please
-   refer to the FAQ for advice in that case.
+   refer to the [FAQ.md] for advice in that case.
 
    If you wish to build the kernel module for an architecture other
    than the architecture of the machine used for the build, you may
@@ -604,3 +604,13 @@ Bug Reporting
 =============
 
 Please report problems to [email protected].
+
+[README.md]:README.md
+[INSTALL.Debian.md]:INSTALL.Debian.md
+[INSTALL.Fedora.md]:INSTALL.Fedora.md
+[INSTALL.RHEL.md]:INSTALL.RHEL.md
+[INSTALL.XenServer.md]:INSTALL.XenServer.md
+[INSTALL.NetBSD.md]:INSTALL.NetBSD.md
+[INSTALL.DPDK.md]:INSTALL.DPDK.md
+[INSTALL.userspace.md]:INSTALL.userspace.md
+[FAQ.md]:FAQ.md

INSTALL.userspace.md

@@ -17,7 +17,7 @@ Building and Installing
 -----------------------
 
 The requirements and procedure for building, installing, and
-configuring Open vSwitch are the same as those given in INSTALL.
+configuring Open vSwitch are the same as those given in [INSTALL.md].
 You may omit configuring, building, and installing the kernel module,
 and the related requirements.
 
@@ -82,3 +82,5 @@ Bug Reporting
 -------------
 
 Please report problems to [email protected].
+
+[INSTALL.md]:INSTALL.md