chiark / gitweb /
Fix description of `alloc'.
[mLib] / README
diff --git a/README b/README
index ab2c79c..6db3631 100644 (file)
--- a/README
+++ b/README
@@ -56,7 +56,7 @@ Quick tour
            for C.
 
          * `alloc.h' declares some thin veneers over `malloc' and
-           `free' which raise exceptions for out-of-memory conditions,
+           friends which raise exceptions for out-of-memory conditions,
            so you don't have to bother trapping these in main code.
 
        Above this are the memory tracking system, the suballocator, and
@@ -68,7 +68,9 @@ Quick tour
            with information about who allocated them, and keeps track
            of the memory allocated so far.  Most of the time, you don't
            bother compiling this in, and you don't need to care about
-           it at all.
+           it at all.  [This may be withdrawn in a later release.  Too
+           much code in mLib doesn't support it properly, and it's not
+           being maintained or documented very well.]
 
          * `sub.h' provides an allocation mechanism for small,
            known-size blocks.  It fetches big chunks from an underlying