Mention g_test_undefined() when documenting assert_failed, assert_stderr

Bug: https://bugzilla.gnome.org/show_bug.cgi?id=666116
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Colin Walters <walters@verbum.org>
This commit is contained in:
Simon McVittie 2012-01-05 15:10:04 +00:00
parent 254efaf85e
commit 2fe964eeb1

View File

@ -213,6 +213,12 @@
* Assert that the last forked test failed.
* See g_test_trap_fork().
*
* This is sometimes used to test situations that are formally considered to
* be undefined behaviour, like inputs that fail a g_return_if_fail()
* check. In these situations you should skip the entire test, including the
* call to g_test_trap_fork(), unless g_test_undefined() returns %TRUE
* to indicate that undefined behaviour may be tested.
*
* Since: 2.16
*/
@ -246,6 +252,12 @@
* Assert that the stderr output of the last forked test
* matches @serrpattern. See g_test_trap_fork().
*
* This is sometimes used to test situations that are formally considered to
* be undefined behaviour, like inputs that fail a g_return_if_fail()
* check. In these situations you should skip the entire test, including the
* call to g_test_trap_fork(), unless g_test_undefined() returns %TRUE
* to indicate that undefined behaviour may be tested.
*
* Since: 2.16
*/