get_expanded_map(): add docstring

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael Haggerty committed Oct 30, 2013 at 06:32 UTC f166db26af524278b42caac8f092d8de5e3e9c29
1 file changed +7
remote.c
+7
@@ -1553,6 +1553,13 @@ static int ignore_symref_update(const char *refname)
1553 return (flag & REF_ISSYMREF);
1554 }
1555
1556 +/*
1557 + * Create and return a list of (struct ref) consisting of copies of
1558 + * each remote_ref that matches refspec. refspec must be a pattern.
1559 + * Fill in the copies' peer_ref to describe the local tracking refs to
1560 + * which they map. Omit any references that would map to an existing
1561 + * local symbolic ref.
1562 + */
1563 static struct ref *get_expanded_map(const struct ref *remote_refs,
1564 const struct refspec *refspec)
1565 {