svn commit: r233095 - projects/net80211_testsuite/wtap/001

[Adrian Chadd]

Author: adrian
Date: Sat Mar 17 19:40:37 2012
New Revision: 233095
URL: http://svn.freebsd.org/changeset/base/233095

Log:
  Document.

Modified:
  projects/net80211_testsuite/wtap/001/test.sh

Modified: projects/net80211_testsuite/wtap/001/test.sh
==============================================================================
--- projects/net80211_testsuite/wtap/001/test.sh	Sat Mar 17 19:35:45 2012	(r233094)
+++ projects/net80211_testsuite/wtap/001/test.sh	Sat Mar 17 19:40:37 2012	(r233095)
@@ -18,6 +18,33 @@ cmd()
 	$*
 }
 
+descr()
+{
+	cat <<EOL
+
+This test establishes that the very basic 802.11s multi-hop
+connectivity works.
+
+It:
+
+* creates four wtap instances
+* creates four vimage instances
+* creates one wlan vap for each wtap instance and places
+  each vap in one of the four vimage instances
+* sets up the visibility to the following:
+
+  A <-> B <-> C <-> D
+
+* does a ping test from each node to each other node.
+
+It is expected that the initial creation and discovery phase
+will take some time so the initial run will fail until discovery
+is done.  A future extension to the test suite should be to
+set lower/upper bounds on the discovery phase time.
+
+EOL
+}
+
 setup()
 {
 	# Create wtap/vimage nodes
@@ -102,8 +129,12 @@ case $1 in
 		teardown
 		exit 0
 	;;
+	'descr')
+		descr
+		exit 0
+	;;
 	*)
-		echo "$0 {setup | run | teardown}"
+		echo "$0 {setup | run | teardown | descr}"
 		exit 127
 	;;
 esac