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
  14 In general, new wrappers should be added to support.h if possible.
  15 However, support.h must remain fully compatible with C90 and therefore
  16 cannot include headers which use identifers not reserved in C90.  If
  17 the wrappers need additional types, additional headers such as
  18 signal.h need to be introduced.
  19
  20 # Test framework
  21
  22 The test framework provides a main program for tests, including a
  23 timeout for hanging tests.  See README-testing.c for a minimal
  24 example, and test-driver.c for details how to use it.  The following
  25 header files provide related declarations:
  26
  27 * check.h
  28 * temp_file.h
  29 * test-driver.h