From: Florian Krohm <florian@eich-krohm.de>
Date: Tue, 2 Sep 2014 09:49:53 +0000 (+0000)
Subject: Add a clarifying comment.
X-Git-Tag: svn/VALGRIND_3_10_0~81
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fca8f55ba08de1df5b727b33dfccdd7b3515162c;p=thirdparty%2Fvalgrind.git

Add a clarifying comment.


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

diff --git a/coregrind/m_mallocfree.c b/coregrind/m_mallocfree.c
index 5e8e459210..043069b36d 100644
--- a/coregrind/m_mallocfree.c
+++ b/coregrind/m_mallocfree.c
@@ -1673,6 +1673,9 @@ void add_one_block_to_stats (Arena* a, SizeT loaned)
    a->stats__tot_bytes  += (ULong)loaned;
 }
 
+/* Allocate a piece of memory of req_pszB bytes on the given arena.
+   The function may return NULL if (and only if) aid == VG_AR_CLIENT.
+   Otherwise, the function returns a non-NULL value. */
 void* VG_(arena_malloc) ( ArenaId aid, const HChar* cc, SizeT req_pszB )
 {
    SizeT       req_bszB, frag_bszB, b_bszB;