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>
72 lines
1.7 KiB
C
72 lines
1.7 KiB
C
#ifndef DECORATE_H
|
|
#define DECORATE_H
|
|
|
|
/*
|
|
* A data structure that associates Git objects to void pointers. See
|
|
* t/unit-tests/t-example-decorate.c for a demonstration of how to use these
|
|
* functions.
|
|
*/
|
|
|
|
/*
|
|
* An entry in the data structure.
|
|
*/
|
|
struct decoration_entry {
|
|
const struct object *base;
|
|
void *decoration;
|
|
};
|
|
|
|
/*
|
|
* The data structure.
|
|
*
|
|
* This data structure must be zero-initialized.
|
|
*/
|
|
struct decoration {
|
|
/*
|
|
* Not used by the decoration mechanism. Clients may use this for
|
|
* whatever they want.
|
|
*/
|
|
const char *name;
|
|
|
|
/*
|
|
* The capacity of "entries".
|
|
*/
|
|
unsigned int size;
|
|
|
|
/*
|
|
* The number of real Git objects (that is, entries with non-NULL
|
|
* "base").
|
|
*/
|
|
unsigned int nr;
|
|
|
|
/*
|
|
* The entries. This is an array of size "size", containing nr entries
|
|
* with non-NULL "base" and (size - nr) entries with NULL "base".
|
|
*/
|
|
struct decoration_entry *entries;
|
|
};
|
|
|
|
/*
|
|
* Add an association from the given object to the given pointer (which may be
|
|
* NULL), returning the previously associated pointer. If there is no previous
|
|
* association, this function returns NULL.
|
|
*/
|
|
void *add_decoration(struct decoration *n, const struct object *obj, void *decoration);
|
|
|
|
/*
|
|
* Return the pointer associated to the given object. If there is no
|
|
* association, this function returns NULL.
|
|
*/
|
|
void *lookup_decoration(struct decoration *n, const struct object *obj);
|
|
|
|
/*
|
|
* Clear all decoration entries, releasing any memory used by the structure.
|
|
* If free_cb is not NULL, it is called for every decoration value currently
|
|
* stored.
|
|
*
|
|
* After clearing, the decoration struct can be used again. The "name" field is
|
|
* retained.
|
|
*/
|
|
void clear_decoration(struct decoration *n, void (*free_cb)(void *));
|
|
|
|
#endif
|