aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAndres Mejia <amejia004@gmail.com>2012-07-16 22:18:26 -0400
committerAndres Mejia <amejia004@gmail.com>2012-09-05 15:07:50 -0400
commita33463957922ba59730f6ea22a24c8c75b3f7d7a (patch)
tree327bd9e2ea9960890b34e75aee67099d37e5a9cd /docs
parent4931faf33118335c4f6edc4eee758730c070bada (diff)
[GSOC] Update documentation describing how to run the test suite program.
Also make note on how to bring up the 'help' message and some of the most useful options.
Diffstat (limited to 'docs')
-rw-r--r--docs/README.linux25
1 files changed, 24 insertions, 1 deletions
diff --git a/docs/README.linux b/docs/README.linux
index 0980ca6fe6..f31da618b6 100644
--- a/docs/README.linux
+++ b/docs/README.linux
@@ -121,7 +121,9 @@ framework is provided directly in XBMC's source tree and has very little
requirements in order to build and run. See the README file for the framework
at 'lib/gtest/README' for specific requirements.
-To compile and run XBMC's test suite, simply type the following.
+To compile and run XBMC's test suite, the configure option '--enable-gtest'
+has to be explicitely set during the configure stage. Once configured, to
+build the testsuite, type the following.
$ make check
@@ -129,6 +131,27 @@ To compile the test suite without running it, type the following.
$ make testsuite
+The test suite program can be run manually as well. The name of the test suite
+program is 'xbmc-test' and will build in the XBMC source tree. To bring up the
+'help' notes for the program, type the following.
+
+ $ ./xbmc-test --gtest_help
+
+The most useful options are,
+
+ --gtest_list_tests
+ List the names of all tests instead of running them. The name of
+ TEST(Foo, Bar) is "Foo.Bar".
+ --gtest_filter=POSTIVE_PATTERNS[-NEGATIVE_PATTERNS]
+ Run only the tests whose name matches one of the positive patterns but
+ none of the negative patterns. '?' matches any single character; '*'
+ matches any substring; ':' separates two patterns.
+
+NOTE: If the '--enable-gtest' option is not set during the configure
+stage, the make targets 'check,' 'testsuite,' and 'testframework' will
+simply show a message saying the framework has not been configured, and then
+silently succeed (i.e. it will not return an error).
+
-----------------------------------------------------------------------------
5. How to run
-----------------------------------------------------------------------------