get_expanded_map(): add docstring

diff --git a/remote.c b/remote.c
index e9fedfa918d6806532184b8735d2761951fd4a2e..bef81cdb6c7c38ae6a7a43bd47c7ccc6f985eec1 100644 (file)
--- a/remote.c
+++ b/remote.c
@@ -1553,6 +1553,13 @@ static int ignore_symref_update(const char *refname)
        return (flag & REF_ISSYMREF);
 }
 
+/*
+ * Create and return a list of (struct ref) consisting of copies of
+ * each remote_ref that matches refspec.  refspec must be a pattern.
+ * Fill in the copies' peer_ref to describe the local tracking refs to
+ * which they map.  Omit any references that would map to an existing
+ * local symbolic ref.
+ */
 static struct ref *get_expanded_map(const struct ref *remote_refs,
                                    const struct refspec *refspec)
 {