Skip to content

Commit

Permalink
doc: Convert FAQ to rST
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Russell Bryant <[email protected]>
  • Loading branch information
stephenfin authored and russellb committed Oct 29, 2016
1 parent a578889 commit edde486
Show file tree
Hide file tree
Showing 9 changed files with 2,100 additions and 2,167 deletions.
2,158 changes: 0 additions & 2,158 deletions FAQ.md

This file was deleted.

2,091 changes: 2,091 additions & 0 deletions FAQ.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions INSTALL.Fedora.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ 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 [FAQ.md]
only the in-tree Linux datapath or user-space datapath is needed. See [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
Expand All @@ -126,5 +126,5 @@ Reporting Bugs
Please report problems to [email protected].

[INSTALL.rst]:INSTALL.rst
[FAQ.md]:FAQ.md
[FAQ.rst]:FAQ.rst
[README.RHEL]:rhel/README.RHEL
4 changes: 2 additions & 2 deletions INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ 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 <FAQ.md>`__ question "What features
(version 3.3 or later). See the `FAQ <FAQ.rst>`__ 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
Expand Down Expand Up @@ -274,7 +274,7 @@ example, to build for a running instance of Linux::
.. note::
If ``--with-linux`` requests building for an unsupported version of Linux,
then ``configure`` will fail with an error message. Refer to the `FAQ
<FAQ.md>`__ for advice in that case.
<FAQ.rst>`__ 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 specify the kernel
Expand Down
2 changes: 1 addition & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ docs = \
CodingStyle.rst \
DESIGN.md \
DocumentationStyle.rst \
FAQ.md \
FAQ.rst \
INSTALL.rst \
INSTALL.Debian.rst \
INSTALL.Docker.rst \
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ To use Open vSwitch...

- ...with SELinux, see `here <INSTALL.SELinux.md>`__.

For answers to common questions, refer to the `FAQ <FAQ.md>`__.
For answers to common questions, refer to the `FAQ <FAQ.rst>`__.

To learn how to set up SSL support for Open vSwitch, see `here
<INSTALL.SSL.md>`__.
Expand Down
2 changes: 1 addition & 1 deletion debian/openvswitch-common.docs
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FAQ.md
FAQ.rst
INSTALL.DPDK.rst
README-native-tunneling.rst
2 changes: 1 addition & 1 deletion rhel/openvswitch-fedora.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ fi
%{_mandir}/man8/ovs-parse-backtrace.8*
%{_mandir}/man8/ovs-testcontroller.8*
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst
%doc FAQ.md NEWS INSTALL.DPDK.rst rhel/README.RHEL
%doc FAQ.rst NEWS INSTALL.DPDK.rst rhel/README.RHEL
/var/lib/openvswitch
/var/log/openvswitch
%ghost %attr(755,root,root) %{_rundir}/openvswitch
Expand Down
2 changes: 1 addition & 1 deletion rhel/openvswitch.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ exit 0
/usr/share/openvswitch/scripts/sysconfig.template
/usr/share/openvswitch/vswitch.ovsschema
/usr/share/openvswitch/vtep.ovsschema
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst FAQ.md NEWS
%doc COPYING DESIGN.md INSTALL.SSL.md NOTICE README.rst WHY-OVS.rst FAQ.rst NEWS
%doc INSTALL.DPDK.rst rhel/README.RHEL README-native-tunneling.rst
/var/lib/openvswitch
/var/log/openvswitch
Expand Down

0 comments on commit edde486

Please sign in to comment.