Minor fixes

Author: francozappa

docs/contributing.rst

@@ -163,8 +163,9 @@ Modbus protocols).
 
 If you want to add a new protocol please look at the ``minicps/protocols.py``
 module. ``Protocol`` is the base class, and the
-``NewProtocolNameProtocol(Protocol)`` should be your new child class containing
-the code to manage it. A good point to start it to take a look
+``[NewProtocolName]Protocol(Protocol)`` should be your new child class
+(inheriting from the ``Protocol`` class) containing
+the code to manage the new protocol. A good point to start it to take a look
 at ``tests/protocols_tests.py`` to see how other protocols classes
 are unit-tested.
 
@@ -194,7 +195,7 @@ Testing
 ========
 
 Unit testing is hard to setup properly! Please if you find any inconsistent unit test or
-decomposable unit test or you want to add a new one.
+decomposable unit test or you want to add a new one then send a PR.
 
 .. }}}
 

docs/userguide.rst

@@ -67,6 +67,18 @@ then you can ``cd swat-s1`` folder and run:
 
    sudo python run.py
 
+And you should see the following:
+
+.. code-block:: console
+
+   *** Ping: testing ping reachability
+   attacker -> plc1 plc2 plc3
+   plc1 -> attacker plc2 plc3
+   plc2 -> attacker plc1 plc3
+   plc3 -> attacker plc1 plc2
+   *** Results: 0% dropped (12/12 received)
+   mininet>
+
 
 .. INSTALL OPTIONAL {{{3
 .. _install-optional:

examples/swat-s1/run.py

@@ -20,7 +20,9 @@ def __init__(self, name, net):
         self.name = name
         self.net = net
 
-        self.net.start()
+        net.start()
+
+        net.pingAll()
 
         # start devices
         plc1, plc2, plc3, s1 = self.net.get(
@@ -35,7 +37,7 @@ def __init__(self, name, net):
 
         CLI(self.net)
 
-        self.net.stop()
+        net.stop()
 
 if __name__ == "__main__":