check.mak: Document GST_CHECKS environment variable in checks 'make help'.

Original commit message from CVS:
* check.mak: (help):
Document GST_CHECKS environment variable in checks 'make help'.

diff --git a/ChangeLog b/ChangeLog
index fe2279d..afda8f4 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-05-07  Tim-Philipp Müller  <tim.muller at collabora co uk>
+
+       * check.mak: (help):
+         Document GST_CHECKS environment variable in checks 'make help'.
+
 2008-05-06  Sebastian Dröge  <slomo@circular-chaos.org>
 
        Patch by: Marc-Andre Lureau <marcandre dot lureau at gmail dot com>

diff --git a/check.mak b/check.mak
index d31569f..3fe42ea 100644 (file)
--- a/check.mak
+++ b/check.mak
@@ -132,6 +132,7 @@ inspect:
             $(GST_INSPECT) $$e > /dev/null 2>&1; done
 
 help:
+       @echo
        @echo "make check                         -- run all checks"
        @echo "make torture                       -- run all checks $(LOOPS) times"
        @echo "make (dir)/(test).check            -- run the given check once"
@@ -146,4 +147,16 @@ help:
        @echo "make (dir)/(test).valgrind.gen-suppressions -- generate suppressions"
        @echo "                                               and save to suppressions.log"
        @echo "make inspect                       -- inspect all plugin features"
+       @echo
+       @echo
+       @echo "Additionally, you can use the GST_CHECKS environment variable to"
+       @echo "specify which test(s) should be run. This is useful if you are"
+       @echo "debugging a failure in one particular test, or want to reproduce"
+       @echo "a race condition in a single test."
+       @echo
+       @echo "Examples:"
+       @echo
+       @echo "  GST_CHECKS=test_this,test_that  make element/foobar.check"
+       @echo "  GST_CHECKS=test_many_threads    make element/foobar.forever"
+       @echo