[PATCH 1/2] refspec: fix documentation referring to refspec_item
From: Jacob Keller <jacob.e.keller@intel.com>
Date: 2020-08-21 21:48:43
Subsystem:
the rest · Maintainer:
Linus Torvalds
From: Jacob Keller <redacted>
In commit d27eb356bf25 ("remote: move doc to remote.h and refspec.h")
the documentation for the refspec structure was moved into refspec.h
This documentation refers to elements of the refspec_item, not the
struct refspec. Move the documentation slightly in order to align it
with the structure it is actually referring to.
Signed-off-by: Jacob Keller <redacted>
---
refspec.h | 27 ++++++++++++++-------------
1 file changed, 14 insertions(+), 13 deletions(-)
diff --git a/refspec.h b/refspec.h
index 23e1555b88ac..8d654e3a3ac4 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;
--
2.28.0.218.ge27853923b9d.dirty