parse_ref_line(): add docstring

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
git-mirror · Dec 12, 2011 · fbd09e4 · fbd09e4
1 parent 19b68b1
commit fbd09e4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/refs.c b/refs.c
@@ -20,6 +20,11 @@ struct ref_array {
 	struct ref_entry **refs;
 };
 
+/*
+ * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
+ * Return a pointer to the refname within the line (null-terminated),
+ * or NULL if there was a problem.
+ */
 static const char *parse_ref_line(char *line, unsigned char *sha1)
 {
 	/*