g_test_run: Document g_test_incomplete's similarity to g_test_skip

Signed-off-by: Simon McVittie <smcv@collabora.com>
This commit is contained in:
Simon McVittie 2018-08-03 14:33:52 +01:00
parent 0a180bb51b
commit 54a5f37f12

View File

@ -1733,11 +1733,13 @@ g_test_get_root (void)
* particular code runs before or after a given test case, use * particular code runs before or after a given test case, use
* g_test_add(), which lets you specify setup and teardown functions. * g_test_add(), which lets you specify setup and teardown functions.
* *
* If all tests are skipped, this function will return 0 if * If all tests are skipped or marked as incomplete (expected failures),
* producing TAP output, or 77 (treated as "skip test" by Automake) otherwise. * this function will return 0 if producing TAP output, or 77 (treated
* as "skip test" by Automake) otherwise.
* *
* Returns: 0 on success, 1 on failure (assuming it returns at all), * Returns: 0 on success, 1 on failure (assuming it returns at all),
* 0 or 77 if all tests were skipped with g_test_skip() * 0 or 77 if all tests were skipped with g_test_skip() and/or
* g_test_incomplete()
* *
* Since: 2.16 * Since: 2.16
*/ */