Signed-off-by: Stephen Finucane
---
FAQ.md| 4 +-
INSTALL.NetBSD.md | 4 +-
Makefile.am | 2 +-
PORTING.md| 326 -
PORTING.rst | 330 ++
5 files changed, 335 insertions(+), 331 deletions(-)
delete mode 100644 PORTING.md
create mode 100644 PORTING.rst
diff --git a/FAQ.md b/FAQ.md
index cfa5e70..9ab5210 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -75,7 +75,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.md] document describes how one would go about
+A: The [PORTING.rst] 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?
@@ -2149,7 +2149,7 @@ Contact
[email protected]
http://openvswitch.org/
-[PORTING.md]:PORTING.md
+[PORTING.rst]:PORTING.rst
[WHY-OVS.md]:WHY-OVS.md
[INSTALL.rst]:INSTALL.rst
[OPENFLOW-1.1+.md]:OPENFLOW-1.1+.md
diff --git a/INSTALL.NetBSD.md b/INSTALL.NetBSD.md
index 3002bad..b89201a 100644
--- a/INSTALL.NetBSD.md
+++ b/INSTALL.NetBSD.md
@@ -31,8 +31,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.rst] and [PORTING.md].
+in the sense described in [INSTALL.userspace.rst] and [PORTING.rst].
[INSTALL.rst]:INSTALL.rst
[INSTALL.userspace.rst]:INSTALL.userspace.rst
-[PORTING.md]:PORTING.md
+[PORTING.rst]:PORTING.rst
diff --git a/Makefile.am b/Makefile.am
index 5e55650..73e94ba 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -88,7 +88,7 @@ docs = \
IntegrationGuide.rst \
MAINTAINERS.rst \
OPENFLOW-1.1+.md \
- PORTING.md \
+ PORTING.rst \
README.md \
README-lisp.md \
README-native-tunneling.md \
diff --git a/PORTING.md b/PORTING.md
deleted file mode 100644
index b7a5073..000
--- a/PORTING.md
+++ /dev/null
@@ -1,326 +0,0 @@
-How to Port Open vSwitch to New Software or Hardware
-
-
-Open vSwitch (OVS) is intended to be easily ported to new software and
-hardware platforms. This document describes the types of changes that
-are most likely to be necessary in porting OVS to Unix-like platforms.
-(Porting OVS to other kinds of platforms is likely to be more
-difficult.)
-
-
-Vocabulary
---
-
-For historical reasons, different words are used for essentially the
-same concept in different areas of the Open vSwitch source tree. Here
-is a concordance, indexed by the area of the source tree:
-
-datapath/ vport ---
-vswitchd/ iface port
-ofproto/portbundle
-ofproto/bond.c slave bond
-lib/lacp.c slave lacp
-lib/netdev.cnetdev ---
-databaseInterface Port
-
-
-Open vSwitch Architectural Overview
-
-The following diagram shows the very high-level architecture of Open
-vSwitch from a porter's perspective.
-
- +---+
- |ovs-vswitchd |<-->ovsdb-server
- +---+
- | ofproto |<-->OpenFlow controllers
- ++-++
- | netdev | | ofproto|
- ++ |provider|
- | netdev | ++
- |provider|
- ++
-
-Some of the components are generic. Modulo bugs or inadequacies,
-these components should not need to be modified as part of a port:
-
- - "ovs-vswitchd" is the main Open vSwitch userspace program, in
-vswitchd/. It reads the desired Open vSwitch configuration from
-the ovsdb-server program over an IPC channel and passes this
-configuration down to the "ofproto" library. It also passes
-certain status and statistical information from ofproto back
-into the database.
-
- - "ofproto" is the Open vSwitch library, in ofproto/, that
-implements an OpenFlow switch. It talks to OpenFlow controllers
-over the network and to switch hardware or software through an
-"ofproto provider", explained further below.
-
- - "netdev" is the Open vSwitch library, in lib/netdev.c, that
-abstracts interacting with network devices, that is, Ethernet
-interfaces. The netdev library is a thin layer over "netdev
-provider" code, explained further below.
-
-The other components may need attention during a port. You will
-almost certainly have to implement a "netdev provider". Depending on
-the type of port you are doing
