From: Nicholas Nethercote <njn@valgrind.org>
Date: Wed, 5 Aug 2009 22:51:17 +0000 (+0000)
Subject: Document the 'cc' param of VG_(malloc) et al.
X-Git-Tag: svn/VALGRIND_3_5_0~127
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2645747abcb43997cd79b20042e7c4a4b69b176c;p=thirdparty%2Fvalgrind.git

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 efab2c2318..fc3649fdd9 100644
--- 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 );