[tor-commits] [ooni-probe/master] Clean up docstrings of scapy test template

[art at torproject.org]

commit b505b1ca9891b5a9049234156ec570fc8847f093
Author: Arturo Filastò <art at fuffa.org>
Date:   Thu Nov 22 11:56:56 2012 +0100

    Clean up docstrings of scapy test template
---
 ooni/templates/scapyt.py |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/ooni/templates/scapyt.py b/ooni/templates/scapyt.py
index ff05922..8d9ea8f 100644
--- a/ooni/templates/scapyt.py
+++ b/ooni/templates/scapyt.py
@@ -45,8 +45,8 @@ class BaseScapyTest(NetTestCase):
     requiresRoot = True
     baseFlags = [
             ['ipsrc', 's', 'Does *not* check if IP src and ICMP IP citation matches when processing answers'],
-            ['seqack', 'k', 'Check if TCP sequence number and ack matches when processing answers'],
-            ['ipid', 'i', 'Check if IP id matches when processing answers']
+            ['seqack', 'k', 'Check if TCP sequence number and ACK match in the ICMP citation when processing answers'],
+            ['ipid', 'i', 'Check if the IPID matches when processing answers']
             ]
 
     def _setUp(self):
@@ -63,6 +63,10 @@ class BaseScapyTest(NetTestCase):
         else:
             config.checkIPID = 0
         # XXX we don't support strict matching
+        # since (from scapy's documentation), some stacks have a bug for which
+        # the bytes in the IPID are swapped.
+        # Perhaps in the future we will want to have more fine grained control
+        # over this.
 
         if self.localOptions['seqack']:
             self.report['answer_flags'].append('seqack')