Update Sphinx version and versioning process
- Updated to newer Sphinx version
- Changed to use doc8 to check .rst files
- Added a dictionary (dict.txt) and spellchecking
- Reformatted and fixed issues that were found in the content
Change-Id: If7b35e01ee8be25dbbd1ecd0e67b264aa6cc2a94
diff --git a/testing/data-plane-testing.rst b/testing/data-plane-testing.rst
index 9c194db..75c5a14 100644
--- a/testing/data-plane-testing.rst
+++ b/testing/data-plane-testing.rst
@@ -4,12 +4,19 @@
OFTest Overview
===============
-The oftest framework consists of a test server connected to a target switch through an OpenFlow channel and directly to the data plane ports of the OF switch.
-After programming the switch, oftest inserts packets in the data plane and verifies if the output is as expected.
+The oftest framework consists of a test server connected to a target switch
+through an OpenFlow channel and directly to the data plane ports of the OF
+switch.
+
+After programming the switch, oftest inserts packets in the data plane and
+verifies if the output is as expected.
.. image:: ../images/testing-oftest.png
-We recommend using a server connected to a management network, a switch connected to the same management network, and then a **minimum of 2 ports directly connected between the server and the switch**.
+We recommend using a server connected to a management network, a switch
+connected to the same management network, and then a **minimum of 2 ports
+directly connected between the server and the switch**.
+
A few tests will fail if you have less than 3 ports.
OFTest Setup
@@ -27,10 +34,15 @@
$ git clone https://gerrit.opencord.org/fabric-oftest
Now let's configure the switch and point it to the test server.
-It can be done in the same way as connecting the switch to any controller.
-See `Connect Switch to Controller <../installation.html#connect-switch-to-controller>`_ for more details.
-Assuming that you plugged the ports ``12`` and ``24`` of the switch to interfaces ``eth1`` and ``eth2`` of the server, respectively, then the following command can tell you if everything is working.
+It can be done in the same way as connecting the switch to any controller.
+
+See `Connect Switch to Controller
+<../installation.html#connect-switch-to-controller>`_ for more details.
+
+Assuming that you plugged the ports ``12`` and ``24`` of the switch to
+interfaces ``eth1`` and ``eth2`` of the server, respectively, then the
+following command can tell you if everything is working.
.. code-block:: console
@@ -69,15 +81,16 @@
flows.PacketInSrcMacMiss ... FAIL
flows.PacketInUDP ... ok
-For example, in this case, all the multicast failed because we don't have three ports, the test L3VPN failed as well, and that is a bug of the current build.
+For example, in this case, all the multicast failed because we don't have three
+ports, the test L3VPN failed as well, and that is a bug of the current build.
The **PacketInSrcMac** Miss failed because Mac learning is not enabled.
.. note::
Expected test results can be found in https://github.com/opencord/fabric-oftest/blob/master/README.md
.. tip::
- OFTest can't successfully delete all groups using an OF message, because of that some tests interfere with others.
- If the results seem suspicious, **erase the flow tables and group tables** and run the test alone.
+ OFTest can't successfully delete all groups using an OF message, because of
+ that some tests interfere with others.
-
-
+ If the results seem suspicious, **erase the flow tables and group tables**
+ and run the test alone.