From owner-svn-src-projects@FreeBSD.ORG  Sat Mar 17 19:40:37 2012
Return-Path: <owner-svn-src-projects@FreeBSD.ORG>
Delivered-To: svn-src-projects@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id C9B68106564A;
	Sat, 17 Mar 2012 19:40:37 +0000 (UTC)
	(envelope-from adrian@FreeBSD.org)
Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c])
	by mx1.freebsd.org (Postfix) with ESMTP id B57158FC0C;
	Sat, 17 Mar 2012 19:40:37 +0000 (UTC)
Received: from svn.freebsd.org (localhost [127.0.0.1])
	by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q2HJebWY084459;
	Sat, 17 Mar 2012 19:40:37 GMT (envelope-from adrian@svn.freebsd.org)
Received: (from adrian@localhost)
	by svn.freebsd.org (8.14.4/8.14.4/Submit) id q2HJebxY084457;
	Sat, 17 Mar 2012 19:40:37 GMT (envelope-from adrian@svn.freebsd.org)
Message-Id: <201203171940.q2HJebxY084457@svn.freebsd.org>
From: Adrian Chadd <adrian@FreeBSD.org>
Date: Sat, 17 Mar 2012 19:40:37 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-projects@freebsd.org
X-SVN-Group: projects
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Cc: 
Subject: svn commit: r233095 - projects/net80211_testsuite/wtap/001
X-BeenThere: svn-src-projects@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: "SVN commit messages for the src &quot; projects&quot;
	tree" <svn-src-projects.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-projects>, 
	<mailto:svn-src-projects-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-projects>
List-Post: <mailto:svn-src-projects@freebsd.org>
List-Help: <mailto:svn-src-projects-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-projects>, 
	<mailto:svn-src-projects-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 17 Mar 2012 19:40:37 -0000

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