doc/overview.txt

   1 HEAD- Overview;;
   2
   3 The following features are provided by NoBug:
   4
   5   * Three different check levels: from detailed to final no-overhead
   6   * Scope tags: tell whenever a function or loop is considered to be bug free
   7   * Precondition, Postcondition and Invariant checks and generic assertions
   8   * Data structures can be dumped
   9   * Application activities can be logged
  10   * Runtime customizable logging via an environment variable
  11   * Different logging targets to stderr, syslog, debugger, ...
  12   * Annotation of your sourcecode about known bugs, things to do, etc.
  13   * Tracking resources (files, locks, etc.) used by your program; help in
  14     detecting misuse
  15   * Detecting potential deadlocks
  16   * Simulate errors by injecting faults
  17   * Coverage checking to find out if all (instrumentated) errors are properly handled
  18   * Additionally, the NoBug project is used to maintain a script and
  19     some tools to setup testsuites
  20
  21 In contrast to traditional debuggers, NoBug is a non-interactive debugger that
  22 is linked to your application doing hard-coded tests in an efficient way
  23 without much overhead. Depending on the build level you choose, NoBug features
  24 will be an integral part of your application making it possible to gather
  25 debugging data for each stage of the application development, including
  26 collecting debugging info for finally deployed applications.
  27
  28
  29 PARA What NoBug can't do;;
  30
  31 NoBug is a (macro-)library, it is not a C/C++ language extension. This
  32 means that code must be called at runtime to benefit from the set up
  33 contracts. What's not tested is likely slipping through the net. Being
  34 part of the program itself, it is affected by memory corruption.
  35 Certain kinds of misuse may introduce new bugs (assert expressions with
  36 side effects for example).
  37
  38
  39 HEAD~ Support; mailinglist; how to reach the NoBug developers
  40
  41 When you need help with NoBug, have some ideas about potential features or
  42 think you found a bug, then you can contact the NoBug community and developers
  43 by sending mail to the NoBug mailinglist. Subscription is available at
  44 http://lists.pipapo.org/cgi-bin/mailman/listinfo/nobug[].
  45