mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 00:58:30 -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>
57 lines
1.8 KiB
C
57 lines
1.8 KiB
C
#ifndef CACHE_TREE_H
|
|
#define CACHE_TREE_H
|
|
|
|
#include "tree.h"
|
|
#include "tree-walk.h"
|
|
|
|
struct cache_tree;
|
|
struct cache_tree_sub {
|
|
struct cache_tree *cache_tree;
|
|
int count; /* internally used by update_one() */
|
|
int namelen;
|
|
int used;
|
|
char name[FLEX_ARRAY];
|
|
};
|
|
|
|
struct cache_tree {
|
|
int entry_count; /* negative means "invalid" */
|
|
struct object_id oid;
|
|
int subtree_nr;
|
|
int subtree_alloc;
|
|
struct cache_tree_sub **down;
|
|
};
|
|
|
|
struct cache_tree *cache_tree(void);
|
|
void cache_tree_free(struct cache_tree **);
|
|
void cache_tree_invalidate_path(struct index_state *, const char *);
|
|
struct cache_tree_sub *cache_tree_sub(struct cache_tree *, const char *);
|
|
|
|
int cache_tree_subtree_pos(struct cache_tree *it, const char *path, int pathlen);
|
|
|
|
void cache_tree_write(struct strbuf *, struct cache_tree *root);
|
|
struct cache_tree *cache_tree_read(const char *buffer, unsigned long size);
|
|
|
|
int cache_tree_fully_valid(struct cache_tree *);
|
|
int cache_tree_update(struct index_state *, int);
|
|
int cache_tree_verify(struct repository *, struct index_state *);
|
|
|
|
/* bitmasks to write_index_as_tree flags */
|
|
#define WRITE_TREE_MISSING_OK 1
|
|
#define WRITE_TREE_IGNORE_CACHE_TREE 2
|
|
#define WRITE_TREE_DRY_RUN 4
|
|
#define WRITE_TREE_SILENT 8
|
|
#define WRITE_TREE_REPAIR 16
|
|
|
|
/* error return codes */
|
|
#define WRITE_TREE_UNREADABLE_INDEX (-1)
|
|
#define WRITE_TREE_UNMERGED_INDEX (-2)
|
|
#define WRITE_TREE_PREFIX_ERROR (-3)
|
|
|
|
struct tree *write_in_core_index_as_tree(struct repository *repo,
|
|
struct index_state *index_state);
|
|
int write_index_as_tree(struct object_id *oid, struct index_state *index_state, const char *index_path, int flags, const char *prefix);
|
|
void prime_cache_tree(struct repository *, struct index_state *, struct tree *);
|
|
|
|
int cache_tree_matches_traversal(struct cache_tree *, struct name_entry *ent, struct traverse_info *info);
|
|
#endif
|