FIX: NOBUG_LOG env parsing error
[nobug.git] / doc / buildlevels.txt
blob6bc06358c7f432006e0cd4f9fd9a1c0070937556
1 HEAD- Debugging Information Granularity: The Build Levels;;
2 INDEX Build Levels; buildlevel; selecting the build level
4 There are three different levels of debugging information available: alpha, beta
5 and release.  One of these levels must be specified before compiling, otherwise
6 an error while compiling will occur.
9   *ALPHA*::
10         This debugging level is envisaged for the development phase of a project
11         where exhaustive testing and logging are required. All NoBug features
12         are enabled.
13   *BETA*::
14         This debugging level is more appropriate for projects beyond the
15         development phase and ready for field-testing with users willing to
16         test the software. The most expensive debugging features are disabled
17         at this level.
18   *RELEASE*::
19         This level is for final, end-users. Logging is mostly retained but
20         assertions and other checking is disabled.
22 .Select a Build Level
23 A logging level can be selected by either using a define before including
24 `nobug.h`, or by passing the appropriate level using the -D switch
25 to the compiler:
27     *ALPHA*::
28        `-DEBUG_ALPHA` / `#define EBUG_ALPHA`
30     *BETA*::
31        `-DEBUG_BETA` / `#define EBUG_BETA`
33     *RELEASE*::
34        `-DNDEBUG` / `#define NDEBUG`
36 If a log level has not been selected, NoBug will abort the
37 compilation with an error.