summaryrefslogtreecommitdiff
path: root/devel/boehm-gc/pkg/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'devel/boehm-gc/pkg/DESCR')
-rw-r--r--devel/boehm-gc/pkg/DESCR23
1 files changed, 23 insertions, 0 deletions
diff --git a/devel/boehm-gc/pkg/DESCR b/devel/boehm-gc/pkg/DESCR
new file mode 100644
index 00000000000..97708039560
--- /dev/null
+++ b/devel/boehm-gc/pkg/DESCR
@@ -0,0 +1,23 @@
+The Boehm-Weiser garbage collection package, for C and C++ -
+garbage collection and memory leak detection libraries.
+
+A garbage collector is something which automatically frees malloc'd
+memory for you by working out what parts of memory your program
+no longer has pointers to. As a result, garbage collectors can also
+inform you of memory leaks (if they find memory they can free, it means
+you have lost all of your pointers to it, but you didn't free it).
+
+This package has two libraries and some include files:
+libgc.a - a garbage collection library, replaces malloc/free/new/delete/etc
+ with versions that do automatic garbage collection
+libleak.a - a leak detection library, which is just libgc.a compiled with
+ different switches.
+
+C programs may be linked against either of these, and should run (with
+GC or leak detection) without change. C++ programs must include a header
+to use garbage collection, though leak detection should work without
+such source code modifications. See the man page and header files.
+
+-- Mike McGaughey <mmcg@cs.monash.edu.au>
+
+ps: garbage collection is addictive.