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>
65 lines
2.0 KiB
C
65 lines
2.0 KiB
C
#ifndef OIDTREE_H
|
|
#define OIDTREE_H
|
|
|
|
#include "cbtree.h"
|
|
#include "hash.h"
|
|
#include "mem-pool.h"
|
|
|
|
/*
|
|
* OID trees are an efficient storage for object IDs that use a critbit tree
|
|
* internally. Common prefixes are duplicated and object IDs are stored in a
|
|
* way that allow easy iteration over the objects in lexicographic order. As a
|
|
* consequence, operations that want to enumerate all object IDs that match a
|
|
* given prefix can be answered efficiently.
|
|
*
|
|
* Note that it is not (yet) possible to store data other than the object IDs
|
|
* themselves in this tree.
|
|
*/
|
|
struct oidtree {
|
|
struct cb_tree tree;
|
|
struct mem_pool mem_pool;
|
|
};
|
|
|
|
/* Initialize the oidtree so that it is ready for use. */
|
|
void oidtree_init(struct oidtree *ot);
|
|
|
|
/*
|
|
* Release all memory associated with the oidtree and reinitialize it for
|
|
* subsequent use.
|
|
*/
|
|
void oidtree_clear(struct oidtree *ot);
|
|
|
|
/*
|
|
* Insert the object ID into the tree and store the given pointer alongside
|
|
* with it. The data pointer of any preexisting entry will be overwritten.
|
|
*/
|
|
void oidtree_insert(struct oidtree *ot, const struct object_id *oid,
|
|
void *data);
|
|
|
|
/* Check whether the tree contains the given object ID. */
|
|
bool oidtree_contains(struct oidtree *ot, const struct object_id *oid);
|
|
|
|
/* Get the payload stored with the given object ID. */
|
|
void *oidtree_get(struct oidtree *ot, const struct object_id *oid);
|
|
|
|
/*
|
|
* Callback function used for `oidtree_each()`. Returning a non-zero exit code
|
|
* will cause iteration to stop. The exit code will be propagated to the caller
|
|
* of `oidtree_each()`.
|
|
*/
|
|
typedef int (*oidtree_each_cb)(const struct object_id *oid,
|
|
void *node_data,
|
|
void *cb_data);
|
|
|
|
/*
|
|
* Iterate through all object IDs in the tree whose prefix matches the given
|
|
* object ID prefix and invoke the callback function on each of them.
|
|
*
|
|
* Returns any non-zero exit code from the provided callback function.
|
|
*/
|
|
int oidtree_each(struct oidtree *ot,
|
|
const struct object_id *prefix, size_t prefix_hex_len,
|
|
oidtree_each_cb cb, void *cb_data);
|
|
|
|
#endif /* OIDTREE_H */
|