.gitignore: Ignore generated files
[memprof.git] / README
bloba60c4d18c2dfe530823d707861f24d8a14675fbf
1 Memprof is a memory profiler and leak detector.
3 Requirements
4 ============
6  For the interface, memprof requires:
8   - GTK+ 2.0
9   - libglade 2.0
11  These are all available from ftp://ftp.gnome.org/pub/GNOME/,
12  but if binary packages are available from your distribution,
13  it's much easier to install them that way.
15 Installation
16 ============
18 ./configure
19 make
20 make install
22 How to report bugs
23 ==================
25 Bugs should be reported to the GNOME bug tracking system.
26 (http://bugzilla.gnome.org/, project memprof). You will need to create an
27 account for yourself.
29 Mailing list
30 ============
32 You can find information about subscribing to the memprof mailing list
33 at: http://mail.gnome.org/mailman/listinfo/memprof-list/.
35 FAQ
36 ===
38 * What do the colors mean?
40   Yellow = Allocated
41   Blue = Allocated then freed (high-water-mark)
42   Red = Leaked (after you press the "Leaks" toolbar button)
44 * What does the message:
46    MemProf: Starter malloc exceeded available space
48   mean?
50   Currently, MemProf doesn't handle static constructors in
51   C++ very well; all memory that they allocate comes out
52   of a fixed size pool. If that size is exceeded, Memprof
53   prints the above message and aborts the program. As a
54   workaround, you may be able to increase the STARTER_SIZE
55   #define in memintercept.c.
57 License
58 =======
60 Memprof is Copyright 1999, 2000, 2001, Red Hat, Inc. Copyright 2002,
61 Kristian Rietveld, and licensed under the terms of the GNU General
62 Public License. See the file COPYING for details.