kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

refspec: fix documentation referring to refspec_item 

In commit d27eb356bf ("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 <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jacob Keller 2020-08-14 17:25:07 -07:00 committed by Junio C Hamano
parent 878e727637
commit 0becfec5b1
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
refspec.h
View File

@ -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;