From 2fe964eeb15843a1e21789d13751b789f520ea4b Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Thu, 5 Jan 2012 15:10:04 +0000 Subject: [PATCH] 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 Reviewed-by: Colin Walters --- glib/gtestutils.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/glib/gtestutils.c b/glib/gtestutils.c index 3406d43..4707375 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 */ -- 2.7.4