Add a helpful comment.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5949

diff --git a/include/valgrind.h b/include/valgrind.h
index b5c8222b4acaa624da84d05163b99e5e98e37720..82d9a78a01b779d172fd3b0e24398c8a52dca985 100644 (file)
--- a/include/valgrind.h
+++ b/include/valgrind.h
@@ -2442,6 +2442,11 @@ VALGRIND_PRINTF_BACKTRACE(const char *format, ...)
    you could miss an error this way).  See memcheck/tests/custom_alloc.c
    for an example.
 
+   WARNING: if your allocator uses malloc() or 'new' to allocate
+   superblocks, rather than mmap() or brk(), this will not work properly --
+   you'll likely get assertion failures during leak detection.  This is
+   because Valgrind doesn't like seeing overlapping heap blocks.  Sorry.
+
    Nb: block must be freed via a free()-like function specified
    with VALGRIND_FREELIKE_BLOCK or mismatch errors will occur. */
 #define VALGRIND_MALLOCLIKE_BLOCK(addr, sizeB, rzB, is_zeroed)    \