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>
77 lines
2.2 KiB
C
77 lines
2.2 KiB
C
#ifndef FETCH_NEGOTIATOR_H
|
|
#define FETCH_NEGOTIATOR_H
|
|
|
|
struct commit;
|
|
struct repository;
|
|
|
|
/*
|
|
* An object that supplies the information needed to negotiate the contents of
|
|
* the to-be-sent packfile during a fetch.
|
|
*
|
|
* To set up the negotiator, call fetch_negotiator_init(), then known_common()
|
|
* (0 or more times), then add_tip() (0 or more times).
|
|
*
|
|
* Then, when "have" lines are required, call next(). Call ack() to report what
|
|
* the server tells us.
|
|
*
|
|
* Once negotiation is done, call release(). The negotiator then cannot be used
|
|
* (unless reinitialized with fetch_negotiator_init()).
|
|
*/
|
|
struct fetch_negotiator {
|
|
/*
|
|
* Before negotiation starts, indicate that the server is known to have
|
|
* this commit.
|
|
*/
|
|
void (*known_common)(struct fetch_negotiator *, struct commit *);
|
|
|
|
/*
|
|
* Once this function is invoked, known_common() cannot be invoked any
|
|
* more.
|
|
*
|
|
* Indicate that this commit and all its ancestors are to be checked
|
|
* for commonality with the server.
|
|
*/
|
|
void (*add_tip)(struct fetch_negotiator *, struct commit *);
|
|
|
|
/*
|
|
* Once this function is invoked, known_common() and add_tip() cannot
|
|
* be invoked any more.
|
|
*
|
|
* Return the next commit that the client should send as a "have" line.
|
|
*/
|
|
const struct object_id *(*next)(struct fetch_negotiator *);
|
|
|
|
/*
|
|
* Inform the negotiator that the server has the given commit. This
|
|
* method must only be called on commits returned by next().
|
|
*/
|
|
int (*ack)(struct fetch_negotiator *, struct commit *);
|
|
|
|
/*
|
|
* Inform the negotiator that this commit has already been sent as
|
|
* a "have" line outside of the negotiator's control. The negotiator
|
|
* should avoid outputting it from next() and may use it to optimize
|
|
* further negotiation (e.g., by treating it and its ancestors as
|
|
* common).
|
|
*/
|
|
void (*have_sent)(struct fetch_negotiator *, struct commit *);
|
|
|
|
void (*release)(struct fetch_negotiator *);
|
|
|
|
/* internal use */
|
|
void *data;
|
|
};
|
|
|
|
/*
|
|
* Initialize a negotiator based on the repository settings.
|
|
*/
|
|
void fetch_negotiator_init(struct repository *r,
|
|
struct fetch_negotiator *negotiator);
|
|
|
|
/*
|
|
* Initialize a noop negotiator.
|
|
*/
|
|
void fetch_negotiator_init_noop(struct fetch_negotiator *negotiator);
|
|
|
|
#endif
|