aboutsummaryrefslogtreecommitdiffstats
path: root/test-skeleton.c
diff options
context:
space:
mode:
authorSteve Ellcey <sellcey@caviumnetworks.com>2016-11-07 08:28:52 -0800
committerSteve Ellcey <sellcey@caviumnetworks.com>2016-11-07 08:28:52 -0800
commit5ffc980589687eed1db3619af6aecf2d31773129 (patch)
treeef7f571a08ddf97f8dd82d542e86b807a715f03f /test-skeleton.c
parent0623b9e6a9c3441427cf8c421bcc81d09e48fdc1 (diff)
downloadtermbaud-5ffc980589687eed1db3619af6aecf2d31773129.tar.gz
termbaud-5ffc980589687eed1db3619af6aecf2d31773129.tar.xz
termbaud-5ffc980589687eed1db3619af6aecf2d31773129.zip
Document do_test in test-skeleton.c
* test-skeleton.c: Document do_test usage.
Diffstat (limited to 'test-skeleton.c')
-rw-r--r--test-skeleton.c17
1 files changed, 16 insertions, 1 deletions
diff --git a/test-skeleton.c b/test-skeleton.c
index 55841fbbdf1..fa457befa5e 100644
--- a/test-skeleton.c
+++ b/test-skeleton.c
@@ -36,7 +36,22 @@
/* The test function is normally called `do_test' and it is called
with argc and argv as the arguments. We nevertheless provide the
- possibility to overwrite this name. */
+ possibility to overwrite this name.
+
+ The TEST_FUNCTION expression should have a type of 'int' and should
+ return 0 to indicate a passing test, 1 to indicate a failing test,
+ or 77 to indicate an unsupported test. Other result values could be
+ used to indicate a failing test, but the result of the expression
+ is passed to exit and exit only returns the lower 8 bits of its input.
+ A non-zero return with some values could cause a test to incorrectly
+ be considered passing when it really failed. For this reason the
+ expression should always return 0, 1, or 77.
+
+ The test function may print out diagnostic or warning messages as well
+ as messages about failures. These messages should be printed to stdout
+ and not stderr so that the output is properly ordered with respect to
+ the rest of the glibc testsuite run output. */
+
#ifndef TEST_FUNCTION
# define TEST_FUNCTION do_test (argc, argv)
#endif