From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Fri, 13 Nov 2009 10:03:28 +0000 (+0000)
Subject: Add unit test env-var doc to 'scons -h'
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=59c388adc3a5a300fd31fb54059ca276cb41a2f2;p=senf.git

Add unit test env-var doc to 'scons -h'

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1522 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/SConstruct b/SConstruct
index 1fd27f0..3b0099c 100644
--- a/SConstruct
+++ b/SConstruct
@@ -17,26 +17,44 @@ senfutil.loadTools(env)
 env.Help("""
 Additional top-level build targets:
 
-prepare        Create all target files not part of the repository
-default        Build all default targets (like calling scons with no arguments)
-examples       Build all examples
-all_tests      Build and run unit tests for all modules
-test_changes   Build tests only for files with local changes (queries svn or git)
-all_docs       Build documentation for all modules
-all            Build everything
-install_all    Install SENF into $$PREFIX
-deb            Build debian source and binary package
-debsrc         Build debian source package
-debbin         Build debian binary package
-linklint       Check links of doxygen documentation with 'linklint'
-fixlinks       Fix broken links in doxygen documentation
-all_valgrinds  Run all tests under valgrind/memcheck
-lcov           Generate test coverage output in doc/lcov and lcov.info
+prepare         Create all target files not part of the repository
+default         Build all default targets (like calling scons with no arguments)
+examples        Build all examples
+all_tests       Build and run unit tests for all modules
+test_changes    Build tests only for files with local changes (queries svn or git)
+all_docs        Build documentation for all modules
+all             Build everything
+install_all     Install SENF into $$PREFIX
+deb             Build debian source and binary package
+debsrc          Build debian source package
+debbin          Build debian binary package
+linklint        Check links of doxygen documentation with 'linklint'
+fixlinks        Fix broken links in doxygen documentation
+all_valgrinds   Run all tests under valgrind/memcheck
+lcov            Generate test coverage output in doc/lcov and lcov.info
 
 You may execute targets on a remote host (if the directory layout is the same)
 by calling
 
     scons <target>@[<user>@]<host>
+
+Some more elaborate unit tests may be enabled by setting appropritate variables 
+in the shell (unix) environment
+
+SENF_TIMING_CRITICAL_TESTS
+                Enables unit tests which depend on timing measurements. These
+                unit tests should only be run on a single core and an otherwise
+                idle system.
+
+SENF_WLAN_TEST_INTERFACE
+                WLAN interface to use for testing. The interface should not be
+                actively in use.
+
+SENF_ETH_TEST_INTERFACE
+                Ethernet interface to use for testing. The interface should not
+                be actively in use.
+
+Some unit tests will only run when executed to 'root'.
 """)
 
 env.Append(
@@ -97,6 +115,9 @@ env.Append(
    LINKFLAGS_debug        = [ '-g' ],
 )
 
+# Add all UNIX env vars starting with 'SENF' to the execution environment
+env.Append( ENV = dict(((k,v) for k,v in os.environ.iteritems() if k.startswith("SENF"))) )
+
 env.SetDefault(
     LIBSENF           = "senf",
     LCOV              = "lcov",