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>
40 lines
1.2 KiB
C
40 lines
1.2 KiB
C
#ifndef SPLIT_INDEX_H
|
|
#define SPLIT_INDEX_H
|
|
|
|
#include "hash.h"
|
|
|
|
struct index_state;
|
|
struct strbuf;
|
|
struct ewah_bitmap;
|
|
|
|
struct split_index {
|
|
struct object_id base_oid;
|
|
struct index_state *base;
|
|
struct ewah_bitmap *delete_bitmap;
|
|
struct ewah_bitmap *replace_bitmap;
|
|
struct cache_entry **saved_cache;
|
|
unsigned int saved_cache_nr;
|
|
unsigned int nr_deletions;
|
|
unsigned int nr_replacements;
|
|
int refcount;
|
|
};
|
|
|
|
struct split_index *init_split_index(struct index_state *istate);
|
|
void save_or_free_index_entry(struct index_state *istate, struct cache_entry *ce);
|
|
void replace_index_entry_in_base(struct index_state *istate,
|
|
struct cache_entry *old,
|
|
struct cache_entry *new_entry);
|
|
int read_link_extension(struct index_state *istate,
|
|
const void *data, unsigned long sz);
|
|
int write_link_extension(struct strbuf *sb,
|
|
struct index_state *istate);
|
|
void move_cache_to_base_index(struct index_state *istate);
|
|
void merge_base_index(struct index_state *istate);
|
|
void prepare_to_write_split_index(struct index_state *istate);
|
|
void finish_writing_split_index(struct index_state *istate);
|
|
void discard_split_index(struct index_state *istate);
|
|
void add_split_index(struct index_state *istate);
|
|
void remove_split_index(struct index_state *istate);
|
|
|
|
#endif
|