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>
67 lines
2.5 KiB
C
67 lines
2.5 KiB
C
#ifndef COMMIT_SLAB_H
|
|
#define COMMIT_SLAB_H
|
|
|
|
#include "commit-slab-decl.h"
|
|
#include "commit-slab-impl.h"
|
|
|
|
/*
|
|
* define_commit_slab(slabname, elemtype) creates boilerplate code to define
|
|
* a new struct (struct slabname) that is used to associate a piece of data
|
|
* of elemtype to commits, and a few functions to use that struct.
|
|
*
|
|
* After including this header file, using:
|
|
*
|
|
* define_commit_slab(indegree, int);
|
|
*
|
|
* will let you call the following functions:
|
|
*
|
|
* - int *indegree_at(struct indegree *, struct commit *);
|
|
*
|
|
* This function locates the data associated with the given commit in
|
|
* the indegree slab, and returns the pointer to it. The location to
|
|
* store the data is allocated as necessary.
|
|
*
|
|
* - int *indegree_peek(struct indegree *, struct commit *);
|
|
*
|
|
* This function is similar to indegree_at(), but it will return NULL
|
|
* if the location to store the data associated with the given commit
|
|
* has not been allocated yet.
|
|
* Note that the location to store the data might have already been
|
|
* allocated even if no indegree_at() call has been made for that commit
|
|
* yet; in this case this function returns a pointer to a
|
|
* zero-initialized location.
|
|
*
|
|
* - void init_indegree(struct indegree *);
|
|
* void init_indegree_with_stride(struct indegree *, int);
|
|
*
|
|
* Initializes the indegree slab that associates an array of integers
|
|
* to each commit. 'stride' specifies how big each array is. The slab
|
|
* that is initialized by the variant without "_with_stride" associates
|
|
* each commit with an array of one integer.
|
|
*
|
|
* - void clear_indegree(struct indegree *);
|
|
*
|
|
* Empties the slab. The slab can be reused with the same stride
|
|
* without calling init_indegree() again or can be reconfigured to a
|
|
* different stride by calling init_indegree_with_stride().
|
|
*
|
|
* Call this function before the slab falls out of scope to avoid
|
|
* leaking memory.
|
|
*
|
|
* - void deep_clear_indegree(struct indegree *, void (*free_fn)(int*))
|
|
*
|
|
* Empties the slab, similar to clear_indegree(), but in addition it
|
|
* calls the given 'free_fn' for each slab entry to release any
|
|
* additional memory that might be owned by the entry (but not the
|
|
* entry itself!).
|
|
* Note that 'free_fn' might be called even for entries for which no
|
|
* indegree_at() call has been made; in this case 'free_fn' is invoked
|
|
* with a pointer to a zero-initialized location.
|
|
*/
|
|
|
|
#define define_commit_slab(slabname, elemtype) \
|
|
declare_commit_slab(slabname, elemtype); \
|
|
implement_static_commit_slab(slabname, elemtype)
|
|
|
|
#endif /* COMMIT_SLAB_H */
|