| Message ID | 20200815002509.2467645-1-jacob.e.keller@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [RFC,1/3] refspec: fix documentation referring to refspec_item | expand |
Jacob Keller <jacob.e.keller@intel.com> writes: > From: Jacob Keller <jacob.keller@gmail.com> > > 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. Makes sense to me. > > Signed-off-by: Jacob Keller <jacob.keller@gmail.com> > --- > 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; > > base-commit: 878e727637ec5815ccb3301eb994a54df95b21b8
On Mon, Aug 17, 2020 at 9:18 AM Junio C Hamano <gitster@pobox.com> wrote: > > Jacob Keller <jacob.e.keller@intel.com> writes: > > > From: Jacob Keller <jacob.keller@gmail.com> > > > > 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. > > Makes sense to me. > Hi Junio, I'm thinking I should send the first two patches a separate preparatory series while I follow up with a v2 of the RFC of negative refspecs Does that seem reasonable? Thanks, Jake
Jacob Keller <jacob.keller@gmail.com> writes: > On Mon, Aug 17, 2020 at 9:18 AM Junio C Hamano <gitster@pobox.com> wrote: >> >> Jacob Keller <jacob.e.keller@intel.com> writes: >> >> > From: Jacob Keller <jacob.keller@gmail.com> >> > >> > 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. >> >> Makes sense to me. >> > > Hi Junio, > > I'm thinking I should send the first two patches a separate > preparatory series while I follow up with a v2 of the RFC of negative > refspecs > > Does that seem reasonable? > > Thanks, > Jake Sure; thanks.
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;