mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 11:47:49 -05:00
9759608622
The Git project is not exactly the easiest project to get started in: it's written in C and POSIX shell, with bits of Perl, Rust and other languages sprinkled into it. On top of that, the project has grown somewhat organically over time, making the codebase hard to navigate. These are problems that we're aware of, and there have been and still are efforts to clean up some of the technical debt that is natural to exist an a project that is more than 20 years old. Furthermore, we provide resources to newcomers that help them out like our coding guidelines, code of conduct or "MyFirstContribution.adoc". But there is a rather practical problem: finding your way around in our project's tree is not easy. Doing a directory listing in the top-level directory will present you with more than 550 files, which makes it extremely hard for a newcomer to figure out what files they are even supposed to look at. This makes the onboarding experience somewhat harder than it really needs to be. This isn't only a problem for newcomers though, as I myself struggle to find the files I am looking for because of the sheer number of files. Besides the problem of discoverability it also creates a problem of structure. It is not obvious at all which files are part of "libgit.a" and which files are only linked into our final executables. So while we have this split in our build systems, that split is not evident at all in our tree. Introduce a new "lib/" directory and move all of our sources for "libgit.a" into it to fix these issues. It makes the split we have evident and reduces the number of files in our top-level tree from 550 files to ~80 files. This is still a lot of files, but it's significantly easier to navigate already. Furthermore, we can further iterate after this step and think about introducing a better structure for remaining files, as well. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
108 lines
3.4 KiB
C
108 lines
3.4 KiB
C
#ifndef REFSPEC_H
|
|
#define REFSPEC_H
|
|
|
|
#define TAG_REFSPEC "refs/tags/*:refs/tags/*"
|
|
|
|
/**
|
|
* 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;
|
|
|
|
char *raw;
|
|
};
|
|
|
|
struct string_list;
|
|
|
|
#define REFSPEC_INIT_FETCH { .fetch = 1 }
|
|
#define REFSPEC_INIT_PUSH { .fetch = 0 }
|
|
|
|
/**
|
|
* 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;
|
|
|
|
unsigned fetch : 1;
|
|
};
|
|
|
|
int refspec_item_init_fetch(struct refspec_item *item, const char *refspec);
|
|
int refspec_item_init_push(struct refspec_item *item, const char *refspec);
|
|
void refspec_item_clear(struct refspec_item *item);
|
|
void refspec_init_fetch(struct refspec *rs);
|
|
void refspec_init_push(struct refspec *rs);
|
|
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);
|
|
|
|
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);
|
|
|
|
int refname_matches_negative_refspec_item(const char *refname, struct refspec *rs);
|
|
|
|
/*
|
|
* Checks if a refname matches a globbing refspec pattern.
|
|
* If replacement is provided, computes the corresponding mapped refname.
|
|
* Returns 1 if refname matches pattern, 0 otherwise.
|
|
*/
|
|
int match_refname_with_pattern(const char *pattern, const char *refname,
|
|
const char *replacement, char **result);
|
|
|
|
/*
|
|
* Queries a refspec for a match and updates the query item.
|
|
* Returns 0 on success, -1 if no match is found or negative refspec matches.
|
|
*/
|
|
int refspec_find_match(struct refspec *rs, struct refspec_item *query);
|
|
|
|
/*
|
|
* Queries a refspec for all matches and appends results to the provided string
|
|
* list.
|
|
*/
|
|
void refspec_find_all_matches(struct refspec *rs,
|
|
struct refspec_item *query,
|
|
struct string_list *results);
|
|
|
|
/*
|
|
* Remove all entries in the input list which match any negative refspec in
|
|
* the refspec list.
|
|
*/
|
|
struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
|
|
|
|
/*
|
|
* Search for a refspec that matches the given name and return the
|
|
* corresponding destination (dst) if a match is found, NULL otherwise.
|
|
*/
|
|
char *apply_refspecs(struct refspec *rs, const char *name);
|
|
|
|
#endif /* REFSPEC_H */
|