remote.c: make singular free_ref() public

peff · gitster · commit 1027186fdd3b · 2019-04-15T14:00:52.000+09:00
We provide a free_refs() function to free a list, but there's no easy
way for a caller to free a single ref. Let's make our singular
free_ref() function public. Since its name is so similar to the
list-freeing free_refs(), and because both of those functions have the
same signature, it might be easy to accidentally use the wrong one.
Let's call the singular version the more verbose "free_one_ref()" to
distinguish it.

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/remote.c b/remote.c
@@ -820,11 +820,11 @@ struct ref *copy_ref_list(const struct ref *ref)
 	return ret;
 }
 
-static void free_ref(struct ref *ref)
+void free_one_ref(struct ref *ref)
 {
 	if (!ref)
 		return;
-	free_ref(ref->peer_ref);
+	free_one_ref(ref->peer_ref);
 	free(ref->remote_status);
 	free(ref->symref);
 	free(ref);
@@ -835,7 +835,7 @@ void free_refs(struct ref *ref)
 	struct ref *next;
 	while (ref) {
 		next = ref->next;
-		free_ref(ref);
+		free_one_ref(ref);
 		ref = next;
 	}
 }
diff --git a/remote.h b/remote.h
@@ -131,8 +131,10 @@ int ref_compare_name(const void *, const void *);
 int check_ref_type(const struct ref *ref, int flags);
 
 /*
- * Frees the entire list and peers of elements.
+ * Free a single ref and its peer, or an entire list of refs and their peers,
+ * respectively.
  */
+void free_one_ref(struct ref *ref);
 void free_refs(struct ref *ref);
 
 struct oid_array;

Original file line number	Diff line number	Diff line change
`@@ -820,11 +820,11 @@ struct ref copy_ref_list(const struct ref ref)`
`820`	`820`	`return ret;`
`821`	`821`	`}`
`822`	`822`
`823`		`-static void free_ref(struct ref *ref)`
	`823`	`+void free_one_ref(struct ref *ref)`
`824`	`824`	`{`
`825`	`825`	`if (!ref)`
`826`	`826`	`return;`
`827`		`- free_ref(ref->peer_ref);`
	`827`	`+ free_one_ref(ref->peer_ref);`
`828`	`828`	`free(ref->remote_status);`
`829`	`829`	`free(ref->symref);`
`830`	`830`	`free(ref);`
`@@ -835,7 +835,7 @@ void free_refs(struct ref *ref)`
`835`	`835`	`struct ref *next;`
`836`	`836`	`while (ref) {`
`837`	`837`	`next = ref->next;`
`838`		`- free_ref(ref);`
	`838`	`+ free_one_ref(ref);`
`839`	`839`	`ref = next;`
`840`	`840`	`}`
`841`	`841`	`}`