5db921054e
Continue the move of existing Documentation/technical/* protocol and file-format documentation into our main documentation space. By moving the things that discuss the protocol we can properly link from e.g. lsrefs.unborn and protocol.version documentation to a manpage we build by default. So far we have been using the "gitformat-" prefix for the documentation we've been moving over from Documentation/technical/*, but for protocol documentation let's use "gitprotocol-*". Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
78 lines
2.3 KiB
C
78 lines
2.3 KiB
C
#ifndef REFSPEC_H
|
|
#define REFSPEC_H
|
|
|
|
#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. If it is a negative refspec, (starts
|
|
* with '^'), negative 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;
|
|
unsigned matching : 1;
|
|
unsigned exact_sha1 : 1;
|
|
unsigned negative : 1;
|
|
|
|
char *src;
|
|
char *dst;
|
|
};
|
|
|
|
#define REFSPEC_FETCH 1
|
|
#define REFSPEC_PUSH 0
|
|
|
|
#define REFSPEC_INIT_FETCH { .fetch = REFSPEC_FETCH }
|
|
#define REFSPEC_INIT_PUSH { .fetch = REFSPEC_PUSH }
|
|
|
|
/**
|
|
* An array of strings can be parsed into a struct refspec using
|
|
* parse_fetch_refspec() or parse_push_refspec().
|
|
*/
|
|
struct refspec {
|
|
struct refspec_item *items;
|
|
int alloc;
|
|
int nr;
|
|
|
|
const char **raw;
|
|
int raw_alloc;
|
|
int raw_nr;
|
|
|
|
int fetch;
|
|
};
|
|
|
|
int refspec_item_init(struct refspec_item *item, const char *refspec,
|
|
int fetch);
|
|
void refspec_item_init_or_die(struct refspec_item *item, const char *refspec,
|
|
int fetch);
|
|
void refspec_item_clear(struct refspec_item *item);
|
|
void refspec_init(struct refspec *rs, int fetch);
|
|
void refspec_append(struct refspec *rs, const char *refspec);
|
|
__attribute__((format (printf,2,3)))
|
|
void refspec_appendf(struct refspec *rs, const char *fmt, ...);
|
|
void refspec_appendn(struct refspec *rs, const char **refspecs, int nr);
|
|
void refspec_clear(struct refspec *rs);
|
|
|
|
int valid_fetch_refspec(const char *refspec);
|
|
int valid_remote_name(const char *name);
|
|
|
|
struct strvec;
|
|
/*
|
|
* Determine what <prefix> values to pass to the peer in ref-prefix lines
|
|
* (see linkgit:gitprotocol-v2[5]).
|
|
*/
|
|
void refspec_ref_prefixes(const struct refspec *rs,
|
|
struct strvec *ref_prefixes);
|
|
|
|
#endif /* REFSPEC_H */
|