parse_ref_line(): add docstring

[git.git] / refs.c

diff --git a/refs.c b/refs.c
index d7d422ffb9917b69287b54904aff2c7f30a23d62..197579205bf8dcc2dc2c1950ef27c7385a50697a 100644 (file)
--- 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)
 {
        /*