[PATCH v2 22/25] string_list_add_refs_by_glob(): add a comment about memory management

From: Michael Haggerty <mhagger@alum.mit.edu>
Date: May 25, 2013, 09:08 UTC
Message-ID: <1369472904-12875-23-git-send-email-mhagger@alum.mit.edu>
In-Reply-To: <1369472904-12875-1-git-send-email-mhagger@alum.mit.edu>

Since string_list_add_one_ref() adds refname to the string list, but the lifetime of refname is limited, it is important that the string_list passed to string_list_add_one_ref() has strdup_strings set. Document this fact.

All current callers do the right thing.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
 notes.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/notes.c b/notes.c
index fa7cdf7..602d956 100644
--- a/notes.c
+++ b/notes.c
@@ -927,6 +927,9 @@ static int string_list_add_one_ref(const char *refname, const unsigned char *sha
 	return 0;
 }
 
+/*
+ * The list argument must have strdup_strings set on it.
+ */
 void string_list_add_refs_by_glob(struct string_list *list, const char *glob)
 {
 	if (has_glob_specials(glob)) {

-- 
1.8.2.3