From 9feb1017c5f16ace32479264aae6d92ed81f0633 Mon Sep 17 00:00:00 2001 From: Thomas Graf Date: Thu, 30 Oct 2014 13:04:14 +0100 Subject: [PATCH] doc: Add more cross references between docs Suggested-by: Lori Jakab Signed-off-by: Thomas Graf Reviewed-by: Flavio Leitner Signed-off-by: Ben Pfaff --- CONTRIBUTING.md | 10 ++++++---- FAQ.md | 18 +++++++++++------- INSTALL.DPDK.md | 8 +++++--- INSTALL.Debian.md | 3 ++- INSTALL.Docker.md | 10 ++++++---- INSTALL.Fedora.md | 4 +++- INSTALL.KVM.md | 11 ++++++----- INSTALL.Libvirt.md | 6 ++++-- INSTALL.NetBSD.md | 8 ++++++-- INSTALL.RHEL.md | 11 +++++++---- INSTALL.SSL.md | 6 ++++-- INSTALL.XenServer.md | 8 +++++--- INSTALL.md | 34 ++++++++++++++++++++++------------ INSTALL.userspace.md | 4 +++- OPENFLOW-1.1+.md | 9 ++++++--- PORTING.md | 6 ++++-- README.md | 40 +++++++++++++++++++++++++--------------- TODO.md | 22 +++++++++++++--------- tutorial/ovs-sandbox | 2 +- 19 files changed, 139 insertions(+), 81 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b434e78e3a9..23c5410a1e6 100644 --- a/CONTRIBUTING.md +++ b/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 diff --git a/FAQ.md b/FAQ.md index 01228eb853d..219129225ff 100644 --- a/FAQ.md +++ b/FAQ.md @@ -61,7 +61,7 @@ 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? @@ -69,8 +69,8 @@ A: The [PORTING](PORTING.md) document describes how one would go about 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 bugs@openvswitch.org 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 diff --git a/INSTALL.DPDK.md b/INSTALL.DPDK.md index d612b8fe3b3..2cc76366031 100644 --- a/INSTALL.DPDK.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.userspace.md]:INSTALL.userspace.md +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.Debian.md b/INSTALL.Debian.md index 59e0c973bf2..b3acc1eca93 100644 --- a/INSTALL.Debian.md +++ b/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 bugs@openvswitch.org. +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.Docker.md b/INSTALL.Docker.md index ca7249ffcd1..ddbef99552f 100644 --- a/INSTALL.Docker.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.Fedora.md b/INSTALL.Fedora.md index bfde181cd54..75b6375c66d 100644 --- a/INSTALL.Fedora.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.KVM.md b/INSTALL.KVM.md index 4d847b6e9c7..cddbf030467 100644 --- a/INSTALL.KVM.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.Libvirt.md b/INSTALL.Libvirt.md index 0ee676cb713..cdda19e11c1 100644 --- a/INSTALL.Libvirt.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.NetBSD.md b/INSTALL.NetBSD.md index 47322505ac7..1c571cff476 100644 --- a/INSTALL.NetBSD.md +++ b/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 diff --git a/INSTALL.RHEL.md b/INSTALL.RHEL.md index 1d3d0f8aee4..8746bc612fb 100644 --- a/INSTALL.RHEL.md +++ b/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,7 +153,7 @@ 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. @@ -161,3 +161,6 @@ Reporting Bugs -------------- Please report problems to bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md +[rhel/README.RHEL]:rhel/README.RHEL diff --git a/INSTALL.SSL.md b/INSTALL.SSL.md index aecb2b5f3d2..06be3033d51 100644 --- a/INSTALL.SSL.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.XenServer.md b/INSTALL.XenServer.md index e4408ddf89c..62c76b9c1e2 100644 --- a/INSTALL.XenServer.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index 536cbfbc4d4..c3168dd61b9 100644 --- a/INSTALL.md +++ b/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 bugs@openvswitch.org. + +[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 diff --git a/INSTALL.userspace.md b/INSTALL.userspace.md index a9f881c3278..300d6c13130 100644 --- a/INSTALL.userspace.md +++ b/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 bugs@openvswitch.org. + +[INSTALL.md]:INSTALL.md diff --git a/OPENFLOW-1.1+.md b/OPENFLOW-1.1+.md index 36fd1681bee..07f7f86caf8 100644 --- a/OPENFLOW-1.1+.md +++ b/OPENFLOW-1.1+.md @@ -218,10 +218,10 @@ Please consider the following: should document it in the appropriate manpage and mention it in NEWS as well. - * Coding style (see the [CodingStyle](CodingStyle.md) file at the - top of the source tree). + * Coding style (see the [CodingStyle.md] file at the top of the + source tree). - * The patch submission guidelines (see CONTRIBUTING). I + * The patch submission guidelines (see [CONTRIBUTING.md]). I recommend using "git send-email", which automatically follows a lot of those guidelines. @@ -229,3 +229,6 @@ Bug Reporting ------------- Please report problems to bugs@openvswitch.org. + +[CONTRIBUTING.md]:CONTRIBUTING.md +[CodingStyle.md]:CodingStyle.md diff --git a/PORTING.md b/PORTING.md index 7e5de00d364..2184a202a4b 100644 --- a/PORTING.md +++ b/PORTING.md @@ -129,8 +129,8 @@ implementation built into Open vSwitch. This ought to work, without writing any more code, as long as the netdev provider that you implemented supports receiving packets. It yields poor performance, however, because every packet passes through the ovs-vswitchd process. -See [INSTALL.userspace](INSTALL.userspace.md) for instructions on how -to configure a userspace switch. +See [INSTALL.userspace.md] for instructions on how to configure a +userspace switch. If the userspace switch is not the right choice for your port, then you will have to write more code. You may implement either an @@ -322,3 +322,5 @@ Questions Please direct porting questions to dev@openvswitch.org. We will try to use questions to improve this porting guide. + +[INSTALL.userspace.md]:INSTALL.userspace.md diff --git a/README.md b/README.md index 5084c310d3c..a83693bcfea 100644 --- a/README.md +++ b/README.md @@ -78,33 +78,30 @@ What other documentation is available? -------------------------------------- To install Open vSwitch on a regular Linux or FreeBSD host, please -read INSTALL. For specifics around installation on a specific +read [INSTALL.md]. 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.Debian.md] +- [INSTALL.Fedora.md] +- [INSTALL.RHEL.md] +- [INSTALL.XenServer.md] To use Open vSwitch... -- ...with Docker on Linux, read [INSTALL.Docker](INSTALL.Docker.md) +- ...with Docker on Linux, read [INSTALL.Docker.md] -- ...with KVM on Linux, read [INSTALL](INSTALL.md), read - [INSTALL.KVM](INSTALL.KVM.md) +- ...with KVM on Linux, read [INSTALL.md], read [INSTALL.KVM.md] -- ...with Libvirt, read [INSTALL.Libvirt](INSTALL.Libvirt.md). +- ...with Libvirt, read [INSTALL.Libvirt.md]. -- ...without using a kernel module, read -[INSTALL.userspace](INSTALL.userspace.md). +- ...without using a kernel module, read [INSTALL.userspace.md]. -For answers to common questions, read FAQ. +For answers to common questions, read [FAQ.md]. -To learn how to set up SSL support for Open vSwitch, read -[INSTALL.SSL](INSTALL.SSL.md). +To learn how to set up SSL support for Open vSwitch, read [INSTALL.SSL.md]. To learn about some advanced features of the Open vSwitch software -switch, read the tutorial in tutorial/Tutorial. +switch, read the [tutorial/Tutorial.md]. Each Open vSwitch userspace program is accompanied by a manpage. Many of the manpages are customized to your configuration as part of the @@ -115,3 +112,16 @@ Contact ------- bugs@openvswitch.org + +[INSTALL.md]:INSTALL.md +[INSTALL.Debian.md]:INSTALL.Debian.md +[INSTALL.Docker.md]:INSTALL.Docker.md +[INSTALL.Fedora.md]:INSTALL.Fedora.md +[INSTALL.KVM.md]:INSTALL.KVM.md +[INSTALL.Libvirt.md]:INSTALL.Libvirt.md +[INSTALL.RHEL.md]:INSTALL.RHEL.md +[INSTALL.SSL.md]:INSTALL.SSL.md +[INSTALL.userspace.md]:INSTALL.userspace.md +[INSTALL.XenServer.md]:INSTALL.XenServer.md +[FAQ.md]:FAQ.md +[tutorial/Tutorial.md]:tutorial/Tutorial.md diff --git a/TODO.md b/TODO.md index 581e213b69b..e2db33b0d83 100644 --- a/TODO.md +++ b/TODO.md @@ -2,7 +2,7 @@ Open vSwitch Project Ideas ========================== This file lists a number of project ideas for Open vSwitch. The ideas -here overlap somewhat with those in the OPENFLOW-1.1+ file. +here overlap somewhat with those in the [OPENFLOW-1.1+.md] file. Programming Project Ideas @@ -11,10 +11,10 @@ Programming Project Ideas Each of these projects would ideally result in a patch or a short series of them posted to ovs-dev. -Please read [CONTRIBUTING](CONTRIBUTING.md) and [CodingStyle](CodingStyle.md) -in the top of the source tree before you begin work. The OPENFLOW-1.1+ -file also has an introduction to how OpenFlow is implemented in Open vSwitch. -It is also a good idea to look around the source tree for related code, and +Please read [CONTRIBUTING.md] and [CodingStyle.md] in the top of the +source tree before you begin work. The [OPENFLOW-1.1+.md] file also has +an introduction to how OpenFlow is implemented in Open vSwitch. It is +also a good idea to look around the source tree for related code, and back through the Git history for commits on related subjects, to allow you to follow existing patterns and conventions. @@ -266,11 +266,11 @@ Please consider the following: should document it in the appropriate manpage and mention it in NEWS as well. - * Coding style (see the [CodingStyle](CodingStyle.md) file at the top - of the source tree). + * Coding style (see the [CodingStyle.md] file at the top of the + source tree). - * The patch submission guidelines (see [CONTRIBUTING](CONTRIBUTING.md)). - I recommend using "git send-email", which automatically follows a + * The patch submission guidelines (see [CONTRIBUTING.md]). I + recommend using "git send-email", which automatically follows a lot of those guidelines. @@ -283,3 +283,7 @@ Please report problems to bugs@openvswitch.org. Local Variables: mode: text End: + +[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md +[CONTRIBUTING.md]:CONTRIBUTING.md +[CodingStyle.md]:CodingStyle.md diff --git a/tutorial/ovs-sandbox b/tutorial/ovs-sandbox index 21066d1e331..45bb2346ca9 100755 --- a/tutorial/ovs-sandbox +++ b/tutorial/ovs-sandbox @@ -136,7 +136,7 @@ if $built; then case $srcdir in '') srcdir=$builddir - if test ! -e "$srcdir"/WHY-OVS; then + if test ! -e "$srcdir"/WHY-OVS.md; then srcdir=`cd $builddir/.. && pwd` fi ;;