support/README

   1 This subdirectory contains infrastructure which is not put into
   2 installed libraries, but may be linked into programs (installed or
   3 not) and tests.
   4
   5 # Error-checking wrappers
   6
   7 These wrappers test for error return codes an terminate the process on
   8 error.  They are declared in these header files:
   9
  10 * support.h
  11 * xsignal.h
  12 * xthread.h
  13 * xtime.h
  14
  15 In general, new wrappers should be added to support.h if possible.
  16 However, support.h must remain fully compatible with C90 and therefore
  17 cannot include headers which use identifers not reserved in C90.  If
  18 the wrappers need additional types, additional headers such as
  19 signal.h need to be introduced.
  20
  21 # Test framework
  22
  23 The test framework provides a main program for tests, including a
  24 timeout for hanging tests.  See README-testing.c for a minimal
  25 example, and test-driver.c for details how to use it.  The following
  26 header files provide related declarations:
  27
  28 * check.h
  29 * temp_file.h
  30 * test-driver.h
  31
  32 For tests that make use of struct timespec, the following header files
  33 contain additional macros and helper functions:
  34
  35 * timespec.h