Document "-s" commandline flag for running test suites

https://bugzilla.gnome.org/show_bug.cgi?id=769135
This commit is contained in:
Daniel Macks 2016-07-24 17:28:48 -04:00 committed by Matthias Clasen
parent f14389bec9
commit b56ededeec

View File

@ -1117,6 +1117,7 @@ parse_args (gint *argc_p,
* - `--verbose`: Run tests verbosely. * - `--verbose`: Run tests verbosely.
* - `-q`, `--quiet`: Run tests quietly. * - `-q`, `--quiet`: Run tests quietly.
* - `-p PATH`: Execute all tests matching the given path. * - `-p PATH`: Execute all tests matching the given path.
* - `-s PATH`: Skip all tests matching the given path.
* This can also be used to force a test to run that would otherwise * This can also be used to force a test to run that would otherwise
* be skipped (ie, a test whose name contains "/subprocess"). * be skipped (ie, a test whose name contains "/subprocess").
* - `-m {perf|slow|thorough|quick|undefined|no-undefined}`: Execute tests according to these test modes: * - `-m {perf|slow|thorough|quick|undefined|no-undefined}`: Execute tests according to these test modes:
@ -1557,8 +1558,9 @@ g_test_get_root (void)
* Runs all tests under the toplevel suite which can be retrieved * Runs all tests under the toplevel suite which can be retrieved
* with g_test_get_root(). Similar to g_test_run_suite(), the test * with g_test_get_root(). Similar to g_test_run_suite(), the test
* cases to be run are filtered according to test path arguments * cases to be run are filtered according to test path arguments
* (`-p testpath`) as parsed by g_test_init(). g_test_run_suite() * (`-p testpath` and `-s testpath`) as parsed by g_test_init().
* or g_test_run() may only be called once in a program. * g_test_run_suite() or g_test_run() may only be called once in a
* program.
* *
* In general, the tests and sub-suites within each suite are run in * In general, the tests and sub-suites within each suite are run in
* the order in which they are defined. However, note that prior to * the order in which they are defined. However, note that prior to
@ -2294,9 +2296,10 @@ g_test_suite_count (GTestSuite *suite)
* *
* Execute the tests within @suite and all nested #GTestSuites. * Execute the tests within @suite and all nested #GTestSuites.
* The test suites to be executed are filtered according to * The test suites to be executed are filtered according to
* test path arguments (`-p testpath`) as parsed by g_test_init(). * test path arguments (`-p testpath` and `-s testpath`) as parsed by
* See the g_test_run() documentation for more information on the * g_test_init(). See the g_test_run() documentation for more
* order that tests are run in. * information on the order that tests are run in.
* *
* g_test_run_suite() or g_test_run() may only be called once * g_test_run_suite() or g_test_run() may only be called once
* in a program. * in a program.