From: Nicholas Nethercote <njn@valgrind.org>
Date: Tue, 27 Mar 2007 07:41:33 +0000 (+0000)
Subject: Augment a comment.
X-Git-Tag: svn/VALGRIND_3_3_0~297
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5b3b070cf701f602915141f8f32015b9a2a814da;p=thirdparty%2Fvalgrind.git

Augment a comment.



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

diff --git a/include/pub_tool_mallocfree.h b/include/pub_tool_mallocfree.h
index 70a6f6969d..118f7520f1 100644
--- a/include/pub_tool_mallocfree.h
+++ b/include/pub_tool_mallocfree.h
@@ -33,6 +33,8 @@
 #define __PUB_TOOL_MALLOCFREE_H
 
 // 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).
 extern void* VG_(malloc)         ( SizeT nbytes );
 extern void  VG_(free)           ( void* p );
 extern void* VG_(calloc)         ( SizeT n, SizeT bytes_per_elem );