diff options
author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-01-05 15:10:04 +0000 |
---|---|---|
committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2012-01-05 15:47:50 +0000 |
commit | 2fe964eeb15843a1e21789d13751b789f520ea4b (patch) | |
tree | 12309c0efeb6ba850a023ff4fa0e45551c6b283b | |
parent | 254efaf85e0bb0748e97a3dbe68153831a96592f (diff) | |
download | glib-2fe964eeb15843a1e21789d13751b789f520ea4b.tar.gz |
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>
-rw-r--r-- | glib/gtestutils.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/glib/gtestutils.c b/glib/gtestutils.c index 3406d432f..4707375fe 100644 --- a/glib/gtestutils.c +++ b/glib/gtestutils.c @@ -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 */ |