Re: [ovs-dev] [PATCH 05/15] doc: Convert README to rST

[Russell Bryant]

On Tue, Oct 18, 2016 at 4:03 PM, Stephen Finucane  wrote:

> Signed-off-by: Stephen Finucane 
> ---
>  INSTALL.rst |   2 +-
>  Makefile.am |   2 +-
>  README.md   | 131 --
> --
>  README.rst  | 116 +++
>  rhel/openvswitch-fedora.spec.in |   2 +-
>  rhel/openvswitch.spec.in|   2 +-
>  utilities/ovs-ctl.8 |   2 +-
>  7 files changed, 121 insertions(+), 136 deletions(-)
>  delete mode 100644 README.md
>  create mode 100644 README.rst
>

I made one minor fix and applied this to master.


diff --git a/README.rst b/README.rst
index b96ba1c..944a7c0 100644
--- a/README.rst
+++ b/README.rst
@@ -81,7 +81,7 @@ specific platform, please see one of the below
installation guides:
 - `Fedora `__
 - `RHEL `__
 - `XenServer `__
-- `Windows 

[ovs-dev] [PATCH 05/15] doc: Convert README to rST

[Stephen Finucane]

Signed-off-by: Stephen Finucane 
---
 INSTALL.rst |   2 +-
 Makefile.am |   2 +-
 README.md   | 131 
 README.rst  | 116 +++
 rhel/openvswitch-fedora.spec.in |   2 +-
 rhel/openvswitch.spec.in|   2 +-
 utilities/ovs-ctl.8 |   2 +-
 7 files changed, 121 insertions(+), 136 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/INSTALL.rst b/INSTALL.rst
index 07d69f1..055f201 100644
--- a/INSTALL.rst
+++ b/INSTALL.rst
@@ -85,7 +85,7 @@ use the userspace-only implementation, at some cost in 
features and performance
 To compile the kernel module on Linux, you must also install the
 following:
 
-- A supported Linux kernel version. Refer to the `README `__
+- A supported Linux kernel version. Refer to the `README `__
   for a list of supported versions.
 
   For optional support of ingress policing, you must enable kernel
diff --git a/Makefile.am b/Makefile.am
index 73e94ba..6117ca8 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -89,7 +89,7 @@ docs = \
MAINTAINERS.rst \
OPENFLOW-1.1+.md \
PORTING.rst \
-   README.md \
+   README.rst \
README-lisp.md \
README-native-tunneling.md \
REPORTING-BUGS.md \
diff --git a/README.md b/README.md
deleted file mode 100644
index f824581..000
--- a/README.md
+++ /dev/null
@@ -1,131 +0,0 @@
-Open vSwitch
-
-
-Build Status:
--
-
-[![Build 
Status](https://travis-ci.org/openvswitch/ovs.png)](https://travis-ci.org/openvswitch/ovs)
-
-What is Open vSwitch?
--
-
-Open vSwitch is a multilayer software switch licensed under the open
-source Apache 2 license.  Our goal is to implement a production
-quality switch platform that supports standard management interfaces
-and opens the forwarding functions to programmatic extension and
-control.
-
-Open vSwitch is well suited to function as a virtual switch in VM
-environments.  In addition to exposing standard control and visibility
-interfaces to the virtual networking layer, it was designed to support
-distribution across multiple physical servers.  Open vSwitch supports
-multiple Linux-based virtualization technologies including
-Xen/XenServer, KVM, and VirtualBox.
-
-The bulk of the code is written in platform-independent C and is
-easily ported to other environments.  The current release of Open
-vSwitch supports the following features:
-
-* Standard 802.1Q VLAN model with trunk and access ports
-* NIC bonding with or without LACP on upstream switch
-* NetFlow, sFlow(R), and mirroring for increased visibility
-* QoS (Quality of Service) configuration, plus policing
-* Geneve, GRE, VXLAN, STT, and LISP tunneling
-* 802.1ag connectivity fault management
-* OpenFlow 1.0 plus numerous extensions
-* Transactional configuration database with C and Python bindings
-* High-performance forwarding using a Linux kernel module
-
-The included Linux kernel module supports Linux 3.10 and up.
-
-Open vSwitch can also operate, at a cost in performance, entirely in
-userspace, without assistance from a kernel module.  This userspace
-implementation should be easier to port than the kernel-based switch.
-It is considered experimental.
-
-What's here?
-
-
-The main components of this distribution are:
-
-* ovs-vswitchd, a daemon that implements the switch, along with
-  a companion Linux kernel module for flow-based switching.
-* ovsdb-server, a lightweight database server that ovs-vswitchd
-  queries to obtain its configuration.
-* ovs-dpctl, a tool for configuring the switch kernel module.
-* Scripts and specs for building RPMs for Citrix XenServer and Red
-  Hat Enterprise Linux.  The XenServer RPMs allow Open vSwitch to
-  be installed on a Citrix XenServer host as a drop-in replacement
-  for its switch, with additional functionality.
-* ovs-vsctl, a utility for querying and updating the configuration
-  of ovs-vswitchd.
-* ovs-appctl, a utility that sends commands to running Open
-  vSwitch daemons.
-
-Open vSwitch also provides some tools:
-
-* ovs-ofctl, a utility for querying and controlling OpenFlow
-  switches and controllers.
-* ovs-pki, a utility for creating and managing the public-key
-  infrastructure for OpenFlow switches.
-* ovs-testcontroller, a simple OpenFlow controller that may be useful
-  for testing (though not for production).
-* A patch to tcpdump that enables it to parse OpenFlow messages.
-
-What other documentation is available?
---
-
-To install Open vSwitch on a regular Linux or FreeBSD host, please
-read [INSTALL.rst]. For specifics around installation on a specific
-platform, please see one of these files:
-
-- [INSTALL.Debian.rst]
-- [INSTALL.Fedora.md]
-- [INSTALL.RHEL.md]
-- [INSTALL.XenServer.rst]
-
-To use Open vSwitch...
-
-- ...with Docker