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>
45 lines
1.4 KiB
C
45 lines
1.4 KiB
C
#ifndef COMMIT_SLAB_DECL_H
|
|
#define COMMIT_SLAB_DECL_H
|
|
|
|
/* allocate ~512kB at once, allowing for malloc overhead */
|
|
#ifndef COMMIT_SLAB_SIZE
|
|
#define COMMIT_SLAB_SIZE (512*1024-32)
|
|
#endif
|
|
|
|
#define declare_commit_slab(slabname, elemtype) \
|
|
\
|
|
struct slabname { \
|
|
unsigned slab_size; \
|
|
unsigned stride; \
|
|
unsigned slab_count; \
|
|
elemtype **slab; \
|
|
}
|
|
|
|
/*
|
|
* Statically initialize a commit slab named "var". Note that this
|
|
* evaluates "stride" multiple times! Example:
|
|
*
|
|
* struct indegree indegrees = COMMIT_SLAB_INIT(1, indegrees);
|
|
*
|
|
*/
|
|
#define COMMIT_SLAB_INIT(stride, var) { \
|
|
COMMIT_SLAB_SIZE / sizeof(**((var).slab)) / (stride), \
|
|
(stride), 0, NULL \
|
|
}
|
|
|
|
#define declare_commit_slab_prototypes(slabname, elemtype) \
|
|
\
|
|
void init_ ##slabname## _with_stride(struct slabname *s, unsigned stride); \
|
|
void init_ ##slabname(struct slabname *s); \
|
|
void clear_ ##slabname(struct slabname *s); \
|
|
void deep_clear_ ##slabname(struct slabname *s, void (*free_fn)(elemtype *ptr)); \
|
|
elemtype *slabname## _at_peek(struct slabname *s, const struct commit *c, int add_if_missing); \
|
|
elemtype *slabname## _at(struct slabname *s, const struct commit *c); \
|
|
elemtype *slabname## _peek(struct slabname *s, const struct commit *c)
|
|
|
|
#define define_shared_commit_slab(slabname, elemtype) \
|
|
declare_commit_slab(slabname, elemtype); \
|
|
declare_commit_slab_prototypes(slabname, elemtype)
|
|
|
|
#endif /* COMMIT_SLAB_DECL_H */
|