mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-28 06:35:27 -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>
89 lines
2.8 KiB
C
89 lines
2.8 KiB
C
#ifndef SHALLOW_H
|
|
#define SHALLOW_H
|
|
|
|
#include "commit.h"
|
|
#include "lockfile.h"
|
|
#include "object.h"
|
|
#include "repository.h"
|
|
#include "strbuf.h"
|
|
|
|
struct oid_array;
|
|
struct strvec;
|
|
|
|
void set_alternate_shallow_file(struct repository *r, const char *path, int override);
|
|
int register_shallow(struct repository *r, const struct object_id *oid);
|
|
int unregister_shallow(const struct object_id *oid);
|
|
int is_repository_shallow(struct repository *r);
|
|
|
|
/*
|
|
* Lock for updating the $GIT_DIR/shallow file.
|
|
*
|
|
* Use `commit_shallow_file()` to commit an update, or
|
|
* `rollback_shallow_file()` to roll it back. In either case, any
|
|
* in-memory cached information about which commits are shallow will be
|
|
* appropriately invalidated so that future operations reflect the new
|
|
* state.
|
|
*/
|
|
struct shallow_lock {
|
|
struct lock_file lock;
|
|
};
|
|
#define SHALLOW_LOCK_INIT { \
|
|
.lock = LOCK_INIT, \
|
|
}
|
|
|
|
/* commit $GIT_DIR/shallow and reset stat-validity checks */
|
|
int commit_shallow_file(struct repository *r, struct shallow_lock *lk);
|
|
/* rollback $GIT_DIR/shallow and reset stat-validity checks */
|
|
void rollback_shallow_file(struct repository *r, struct shallow_lock *lk);
|
|
|
|
int get_shallows_depth(struct object_array *heads, struct object_array *shallows);
|
|
struct commit_list *get_shallow_commits(struct object_array *heads,
|
|
struct object_array *shallows, int deepen_relative,
|
|
int depth, int shallow_flag, int not_shallow_flag);
|
|
struct commit_list *get_shallow_commits_by_rev_list(struct strvec *argv,
|
|
int shallow_flag, int not_shallow_flag);
|
|
int write_shallow_commits(struct strbuf *out, int use_pack_protocol,
|
|
const struct oid_array *extra);
|
|
|
|
void setup_alternate_shallow(struct shallow_lock *shallow_lock,
|
|
const char **alternate_shallow_file,
|
|
const struct oid_array *extra);
|
|
|
|
const char *setup_temporary_shallow(const struct oid_array *extra);
|
|
|
|
void advertise_shallow_grafts(int);
|
|
|
|
#define PRUNE_SHOW_ONLY 1
|
|
#define PRUNE_QUICK 2
|
|
void prune_shallow(unsigned options);
|
|
|
|
/*
|
|
* Initialize with prepare_shallow_info() or zero-initialize (equivalent to
|
|
* prepare_shallow_info with a NULL oid_array).
|
|
*/
|
|
struct shallow_info {
|
|
struct oid_array *shallow;
|
|
size_t *ours, nr_ours;
|
|
size_t *theirs, nr_theirs;
|
|
struct oid_array *ref;
|
|
|
|
/* for receive-pack */
|
|
uint32_t **used_shallow;
|
|
int *need_reachability_test;
|
|
int *reachable;
|
|
int *shallow_ref;
|
|
struct commit_stack commits;
|
|
};
|
|
|
|
void prepare_shallow_info(struct shallow_info *, struct oid_array *);
|
|
void clear_shallow_info(struct shallow_info *);
|
|
void remove_nonexistent_theirs_shallow(struct shallow_info *);
|
|
void assign_shallow_commits_to_refs(struct shallow_info *info,
|
|
uint32_t **used,
|
|
int *ref_status);
|
|
int delayed_reachability_test(struct shallow_info *si, int c);
|
|
|
|
extern struct trace_key trace_shallow;
|
|
|
|
#endif /* SHALLOW_H */
|