Document the 'cc' param of VG_(malloc) et al.

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

diff --git a/include/pub_tool_mallocfree.h b/include/pub_tool_mallocfree.h
index efab2c2318be5d75a1b1e6384a163d85ea9ca907..fc3649fdd9ba83e9a12ec141c2822f89aa2bb591 100644 (file)
--- a/include/pub_tool_mallocfree.h
+++ b/include/pub_tool_mallocfree.h
@@ -35,6 +35,8 @@
 // These can be for allocating memory used by tools.
 // Nb: the allocators *always succeed* -- they never return NULL (Valgrind
 // will abort if they can't allocate the memory).
+// The 'cc' is a string that identifies the allocation point.  It's used when
+// --profile-heap=yes is specified.
 extern void* VG_(malloc)         ( HChar* cc, SizeT nbytes );
 extern void  VG_(free)           ( void* p );
 extern void* VG_(calloc)         ( HChar* cc, SizeT n, SizeT bytes_per_elem );