summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--refspec.h27
1 files changed, 14 insertions, 13 deletions
diff --git a/refspec.h b/refspec.h
index 23e1555b88..8d654e3a3a 100644
--- a/refspec.h
+++ b/refspec.h
@@ -4,6 +4,19 @@
#define TAG_REFSPEC "refs/tags/*:refs/tags/*"
extern const struct refspec_item *tag_refspec;
+/**
+ * A struct refspec_item holds the parsed interpretation of a refspec. If it will
+ * force updates (starts with a '+'), force is true. If it is a pattern
+ * (sides end with '*') pattern is true. src and dest are the two sides
+ * (including '*' characters if present); if there is only one side, it is src,
+ * and dst is NULL; if sides exist but are empty (i.e., the refspec either
+ * starts or ends with ':'), the corresponding side is "".
+ *
+ * remote_find_tracking(), given a remote and a struct refspec_item with either src
+ * or dst filled out, will fill out the other such that the result is in the
+ * "fetch" specification for the remote (note that this evaluates patterns and
+ * returns a single result).
+ */
struct refspec_item {
unsigned force : 1;
unsigned pattern : 1;
@@ -21,20 +34,8 @@ struct refspec_item {
#define REFSPEC_INIT_PUSH { .fetch = REFSPEC_PUSH }
/**
- * A struct refspec holds the parsed interpretation of a refspec. If it will
- * force updates (starts with a '+'), force is true. If it is a pattern
- * (sides end with '*') pattern is true. src and dest are the two sides
- * (including '*' characters if present); if there is only one side, it is src,
- * and dst is NULL; if sides exist but are empty (i.e., the refspec either
- * starts or ends with ':'), the corresponding side is "".
- *
- * An array of strings can be parsed into an array of struct refspecs using
+ * An array of strings can be parsed into a struct refspec using
* parse_fetch_refspec() or parse_push_refspec().
- *
- * remote_find_tracking(), given a remote and a struct refspec with either src
- * or dst filled out, will fill out the other such that the result is in the
- * "fetch" specification for the remote (note that this evaluates patterns and
- * returns a single result).
*/
struct refspec {
struct refspec_item *items;