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>
34 lines
1.0 KiB
C
34 lines
1.0 KiB
C
#ifndef ODB_SOURCE_INMEMORY_H
|
|
#define ODB_SOURCE_INMEMORY_H
|
|
|
|
#include "odb/source.h"
|
|
|
|
struct oidtree;
|
|
|
|
/*
|
|
* An in-memory source that you can write objects to that shall be made
|
|
* available for reading, but that shouldn't ever be persisted to disk. Note
|
|
* that any objects written to this source will be stored in memory, so the
|
|
* number of objects you can store is limited by available system memory.
|
|
*/
|
|
struct odb_source_inmemory {
|
|
struct odb_source base;
|
|
struct oidtree *objects;
|
|
};
|
|
|
|
/* Create a new in-memory object database source. */
|
|
struct odb_source_inmemory *odb_source_inmemory_new(struct object_database *odb);
|
|
|
|
/*
|
|
* Cast the given object database source to the in-memory backend. This will
|
|
* cause a BUG in case the source doesn't use this backend.
|
|
*/
|
|
static inline struct odb_source_inmemory *odb_source_inmemory_downcast(struct odb_source *source)
|
|
{
|
|
if (source->type != ODB_SOURCE_INMEMORY)
|
|
BUG("trying to downcast source of type '%d' to in-memory", source->type);
|
|
return container_of(source, struct odb_source_inmemory, base);
|
|
}
|
|
|
|
#endif
|