favicon test
[www_nobug/.git] / index.txt
1 image::/images/nobug-logo.png[squished bug]
2
3 [abstract]
4 *****************************************************************
5 NoBug is a debugging library for instrumenting C and C++ programs
6 *****************************************************************
7
8 NoBug is a library which provides assertions, logging statements, and
9 annotations for C and C++ programs. It includes pre-/post-condition and
10 invariant checks, as well as generic assertions. Checks are enabled based on
11 build-levels and scope tags. It also includes debugger support (valgrind),
12 dumping of data structures, logging your application's activities, runtime
13 customizable logging via environment variables, different logging targets
14 (ringbuffer, stderr, syslog, debugger, etc.), and annotation of your source
15 code regarding known bugs, things to do, and planned things. It can track
16 resources and detect deadlocks. Further it can be used to instrumentate your
17 source to simulate errors by injecting faults and do coverage checking to find
18 out if all (instrumentated) errors are properly handled. Additionally, the
19 NoBug project is used to maintain a script and some tools to setup testsuites
20
21
22 Documentation
23 -------------
24
25 NoBug ships with detailed documentation in a `README` file, you can
26 read it http:/nobug_manual[online] too or
27 http:/releases/nobug_manual.pdf[download a PDF] for printing a hardcopy.
28
29
30 Download
31 --------
32
33 Releases
34 ~~~~~~~~
35
36 Tarballs are available at:
37
38 http://nobug.pipapo.org/releases/[]
39
40
41 Git Access
42 ~~~~~~~~~~
43
44 .Official Repository
45
46 You can obtain a development version using Git.  The Git repository can be
47 cloned from `git://git.pipapo.org/nobug`:
48
49  git clone git://git.pipapo.org/nobug
50
51 The Source is browseable through gitweb
52 http://git.pipapo.org/?p=nobug;a=summary
53
54 .Mob Repository
55
56 There is an anonymous pushable git repository at
57
58  git://git.pipapo.org/mob/nobug
59
60 Code can be pushed there without authentication, do not trust this code unreviewed.
61 The purpose of this mob repository is to have an easy way for contributors to
62 send fixes and improvements upstream. Feel free to push your changes there by
63 opening your own branch and announce what you pushed on the mailinglist.
64
65 This repository is also browseable by gitweb
66 http://git.pipapo.org/?p=mob/nobug;a=summary
67
68
69 License
70 -------
71
72 NoBug is free software; you can redistribute it and/or
73 modify it under the terms of the GNU General Public License
74 as published by the Free Software Foundation; either version 2
75 of the License, or (at your option) any later version.
76
77 For users who are not able to use GPL'ed software relicensing is possible. To
78 make this possible, developers and contributors are requested to comply with a
79 "Contributor Agreement" the rationale behind this is explained in the
80 http://nobug.pipapo.org/nobug_manual#_license[documentation].
81
82
83 Development and Support
84 -----------------------
85
86 When you need help with NoBug, have some ideas about potential features or
87 think you found a bug, then you can contact the NoBug community and developers
88 by sending mail to the NoBug mailinglist.
89
90 http://lists.pipapo.org/cgi-bin/mailman/listinfo/nobug[Subscribe to the Malinglist]
91
92 http://lists.pipapo.org/pipermail/nobug/[Browse the Mailinglist Archives]
93
94