mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 13:21:17 -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>
57 lines
1.7 KiB
C
57 lines
1.7 KiB
C
/*
|
|
* crit-bit tree implementation, does no allocations internally
|
|
* For more information on crit-bit trees: https://cr.yp.to/critbit.html
|
|
* Based on Adam Langley's adaptation of Dan Bernstein's public domain code
|
|
* git clone https://github.com/agl/critbit.git
|
|
*
|
|
* This is adapted to store arbitrary data (not just NUL-terminated C strings
|
|
* and allocates no memory internally. The user needs to allocate
|
|
* "struct cb_node" and provide `key_offset` to indicate where the key can be
|
|
* found relative to the `struct cb_node` for memcmp.
|
|
* If "klen" is variable, then it should be embedded into the key.
|
|
* Recursion is bound by the maximum value of "klen" used.
|
|
*/
|
|
#ifndef CBTREE_H
|
|
#define CBTREE_H
|
|
|
|
struct cb_node;
|
|
struct cb_node {
|
|
struct cb_node *child[2];
|
|
/*
|
|
* n.b. uint32_t for `byte' is excessive for OIDs,
|
|
* we may consider shorter variants if nothing else gets stored.
|
|
*/
|
|
uint32_t byte;
|
|
uint8_t otherbits;
|
|
};
|
|
|
|
struct cb_tree {
|
|
struct cb_node *root;
|
|
ptrdiff_t key_offset;
|
|
};
|
|
|
|
static inline void cb_init(struct cb_tree *t,
|
|
ptrdiff_t key_offset)
|
|
{
|
|
struct cb_tree blank = {
|
|
.key_offset = key_offset,
|
|
};
|
|
memcpy(t, &blank, sizeof(*t));
|
|
}
|
|
|
|
struct cb_node *cb_lookup(struct cb_tree *, const uint8_t *k, size_t klen);
|
|
struct cb_node *cb_insert(struct cb_tree *, struct cb_node *, size_t klen);
|
|
|
|
/*
|
|
* Callback invoked by `cb_each()` for each node in the critbit tree. A return
|
|
* value of 0 will cause the iteration to continue, a non-zero return code will
|
|
* cause iteration to abort. The error code will be relayed back from
|
|
* `cb_each()` in that case.
|
|
*/
|
|
typedef int (*cb_iter)(struct cb_node *, void *arg);
|
|
|
|
int cb_each(struct cb_tree *, const uint8_t *kpfx, size_t klen,
|
|
cb_iter, void *arg);
|
|
|
|
#endif /* CBTREE_H */
|