FIX: NOBUG_LOG env parsing error
[nobug] / doc / nobug_manual.conf
1 //_ NoBug Reference Manual
2 //_ ======================
3 //_ Christian_Th├Ąter,_Benny_Lyons
4 //_
5 //_ [abstract]
6 //_ *****************************************************************
7 //_ NoBug is a debugging library for instrumenting C and C++ programs
8 //_ inspired by ideas originating from Design-by-Contract.
9 //_ *****************************************************************
10 //_
11 //_ [quote]
12 //_ __________________________________________________________________
13 //_ Everyone makes mistakes, but with NoBug you won't make them twice!
14 //_ __________________________________________________________________
15 //_
16 //_ ifdef::basebackend-latex[]
17 //_ Contents
18 //_ --------
19 //_ endif::basebackend-latex[]
20 //_
21 //=overview
22 //=buildinstall
23
24 //=using
25 //=additional
26 //=whichlibrary
27 //=initialization
28
29 //=buildlevels
30
31 //=logging
32 //=logconfiguration
33 //=logflags
34 //=logflagsenv
35
36 //=predefflags
37
38 //=logflagsexample
39
40 //=logformat
41
42 //=macros
43
44 //=parametertable
45
46 //=srccontext
47
48 //=assertions
49
50 //=logmacros
51
52 //=dumping
53 //=dumpmacros
54 //=dumpexample
55
56 //=annotations
57 //=annotationtable
58
59 //=scopechecks
60
61 //=assertiontable
62
63 //=faultinjection
64
65 //=coverageintro
66 //=coverage
67
68 //=resourcetracking
69 //=resourcemacros
70
71 //=resourceexample
72
73 //=resourcedeadlock
74
75 //=callbacks
76
77 //=toolmacros
78
79 //=multithreading
80
81 //=rbdump
82
83 NoBug maintains a `test.sh` script which drives extensive testsuites.
84 Look at into the 'tests/' folder about how to apply this.
85
86 //_ include::test_inc.txt[]
87
88 //=bestpractices
89
90 //_
91 //_ Appendix
92 //_ --------
93 //_
94 //=dlalgo
95
96 //_
97 //_ Reference Index
98 //_ ---------------
99 //_
100 //_ [dotted]
101 //=index
102 //_
103
104 //=license
105
106 //_ Credits
107 //_ -------
108 //_
109 //=credits
110
111
112 Lost & Found:
113
114
115 Release builds remove all assertions, but logging is still kept. We
116 make the assumption that bugs which were not covered in alpha and beta
117 builds will not easily show up in releases because the assertions
118 there were not sufficient. Furthermore, end users are not test bunnies
119 and will not provide good bug reports anyway. If there is a problem in
120 a release build, try to track down the cause using a beta build from
121 the same source.
122
123
124
125