doc: Convert INSTALL.Fedora to rST

Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Russell Bryant <[email protected]>

INSTALL.Fedora.rst

@@ -0,0 +1,144 @@
+..
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+      Convention for heading levels in Open vSwitch documentation:
+
+      =======  Heading 0 (reserved for the title in a document)
+      -------  Heading 1
+      ~~~~~~~  Heading 2
+      +++++++  Heading 3
+      '''''''  Heading 4
+
+      Avoid deeper levels because they do not render well.
+
+============================
+Open vSwitch on Fedora Linux
+============================
+
+This document provides instructions for building and installing Open vSwitch
+RPM packages on a Fedora Linux host. Instructions for the installation of Open
+vSwitch on a Fedora Linux host without using RPM packages can be found in the
+`general installation guide <INSTALL.rst>`__.
+
+These instructions have been tested with Fedora 23, and are also applicable for
+RHEL 7.x and its derivatives, including CentOS 7.x and Scientific Linux 7.x.
+
+Build Requirements
+------------------
+
+To build packages for a Fedora Linux host, you will need the packages described
+in the `general installation guide <INSTALL.rst>`__. Specific packages (by
+package name) include:
+
+- rpm-build
+- autoconf automake libtool
+- systemd-units openssl openssl-devel
+- python python-twisted-core python-zope-interface python-six
+- desktop-file-utils
+- groff graphviz
+- procps-ng
+
+And (optionally):
+
+- libcap-ng libcap-ng-devel
+- dpdk-devel
+
+Bootstraping
+------------
+
+Refer to the *Bootstrapping* section of the `general installation guide
+<INSTALL.rst>`__.
+
+Configuring
+-----------
+
+Refer to the *Configuring* section of the `general installation guide
+<INSTALL.rst>`__.
+
+Building
+--------
+
+User Space RPMs
+~~~~~~~~~~~~~~~
+
+To build Open vSwitch user-space RPMs, execute the following from the directory
+in which `./configure` was executed:
+
+::
+
+    $ make rpm-fedora
+
+This will create the RPMs `openvswitch`, `python-openvswitch`,
+`openvswitch-test`, `openvswitch-devel`, `openvswitch-ovn-common`,
+`openvswitch-ovn-central`, `openvswitch-ovn-host`, `openvswitch-ovn-vtep`,
+`openvswitch-ovn-docker`, and `openvswitch-debuginfo`.
+
+To enable DPDK support in the openvswitch package, the ``--with dpdk`` option
+can be added:
+
+::
+
+    $ make rpm-fedora RPMBUILD_OPT="--with dpdk"
+
+The above commands automatically run the Open vSwitch unit tests, which can
+take several minutes.  To reduce the build time by disabling the execution of
+these tests, the ``--without check`` option can be added:
+
+::
+
+    $ make rpm-fedora RPMBUILD_OPT="--without check"
+
+Kernel OVS Tree Datapath RPM
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To build the Open vSwitch kernel module for the currently running kernel
+version, run:
+
+::
+
+    $ make rpm-fedora-kmod
+
+To build the Open vSwitch kernel module for another kernel version, the desired
+kernel version can be specified via the `kversion` macro.  For example:
+
+::
+
+    $ make rpm-fedora-kmod \
+         RPMBUILD_OPT='-D "kversion 4.3.4-300.fc23.x86_64"'
+
+Installing
+----------
+
+RPM packages can be installed by using the command ``rpm -i``. Package
+installation requires superuser privileges.
+
+The `openvswitch-kmod` RPM should be installed first if the Linux OVS tree
+datapath module is to be used. The `openvswitch-kmod` RPM should not be
+installed if only the in-tree Linux datapath or user-space datapath is needed.
+See the `FAQ document <FAQ.rst>`__ for more information about the various Open
+vSwitch datapath options.
+
+In most cases only the `openvswitch` RPM will need to be installed. The
+`python-openvswitch`, `openvswitch-test`, `openvswitch-devel`, and
+`openvswitch-debuginfo` RPMs are optional unless required for a specific
+purpose.
+
+The `openvswitch-ovn-*` packages are only needed when using OVN.
+
+Refer to the `RHEL README <rhel/README.RHEL.rst>`__ for additional usage and
+configuration information.
+
+Reporting Bugs
+--------------
+
+Report problems to [email protected].

INSTALL.RHEL.md

@@ -8,7 +8,7 @@ on a generic Linux host, see [INSTALL.rst] instead.
 We have tested these instructions with RHEL 5.6 and RHEL 6.0.
 
 For RHEL 7.x (or derivatives, such as CentOS 7.x), you should follow
-the instructions in [INSTALL.Fedora.md].  The Fedora spec files are
+the instructions in [INSTALL.Fedora.rst].  The Fedora spec files are
 used for RHEL 7.x.
 
 Building Open vSwitch for RHEL
@@ -167,5 +167,5 @@ Reporting Bugs
 Please report problems to [email protected].
 
 [INSTALL.rst]:INSTALL.rst
-[INSTALL.Fedora.md]:INSTALL.Fedora.md
+[INSTALL.Fedora.rst]:INSTALL.Fedora.rst
 [rhel/README.RHEL.rst]:rhel/README.RHEL.rst

INSTALL.SELinux.md

@@ -55,7 +55,7 @@ feature set that your SELinux implementation supports.
 Installation
 ------------
 
-Refer to [INSTALL.Fedora.md] for instructions on how to build all
+Refer to [INSTALL.Fedora.rst] for instructions on how to build all
 Open vSwitch rpm packages.
 
 Once the package is built, install it on your Linux distribution with:
@@ -154,7 +154,7 @@ patches to Open vSwitch developer mailing list:
    policy features that are supported by the lowest SELinux version
    out there.  Typically this means that you should test your SELinux
    policy changes on the oldest RHEL or CentOS version that this
-   OVS version supports.  Check INSTALL.Fedora.md file to find out
+   OVS version supports.  Check INSTALL.Fedora.rst file to find out
    this.
 
 3. The SELinux policy is enforced only when state transition to

INSTALL.rst

@@ -30,7 +30,7 @@ Linux, FreeBSD, or NetBSD host. For specifics around installation on a specific
 platform, refer to one of these installation guides:
 
 - `Debian <INSTALL.Debian.rst>`__
-- `Fedora <INSTALL.Fedora.md>`__
+- `Fedora <INSTALL.Fedora.rst>`__
 - `RHEL <INSTALL.RHEL.md>`__
 - `XenServer <INSTALL.XenServer.rst>`__
 - `NetBSD <INSTALL.NetBSD.md>`__

Makefile.am

@@ -76,7 +76,7 @@ docs = \
 	INSTALL.Docker.rst \
 	INSTALL.DPDK-ADVANCED.md \
 	INSTALL.DPDK.rst \
-	INSTALL.Fedora.md \
+	INSTALL.Fedora.rst \
 	INSTALL.KVM.rst \
 	INSTALL.Libvirt.md \
 	INSTALL.NetBSD.md \

README.rst

@@ -78,7 +78,7 @@ To install Open vSwitch on a regular Linux or FreeBSD host, please read the
 specific platform, please see one of the below installation guides:
 
 - `Debian <INSTALL.Debian.rst>`__
-- `Fedora <INSTALL.Fedora.md>`__
+- `Fedora <INSTALL.Fedora.rst>`__
 - `RHEL <INSTALL.RHEL.md>`__
 - `XenServer <INSTALL.XenServer.rst>`__
 - `Windows <INSTALL.Windows.rst>`__