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>
62 lines
1.8 KiB
C
62 lines
1.8 KiB
C
#ifndef TREE_H
|
|
#define TREE_H
|
|
|
|
#include "object.h"
|
|
|
|
struct pathspec;
|
|
struct repository;
|
|
struct strbuf;
|
|
|
|
struct tree {
|
|
struct object object;
|
|
void *buffer;
|
|
unsigned long size;
|
|
};
|
|
|
|
extern const char *tree_type;
|
|
|
|
struct tree *lookup_tree(struct repository *r, const struct object_id *oid);
|
|
|
|
int parse_tree_buffer(struct tree *item, void *buffer, unsigned long size);
|
|
|
|
#define parse_tree_gently(t, q) repo_parse_tree_gently(the_repository, t, q)
|
|
int repo_parse_tree_gently(struct repository *r, struct tree *item,
|
|
int quiet_on_missing);
|
|
#define parse_tree(t) repo_parse_tree(the_repository, t)
|
|
static inline int repo_parse_tree(struct repository *r, struct tree *item)
|
|
{
|
|
return repo_parse_tree_gently(r, item, 0);
|
|
}
|
|
void free_tree_buffer(struct tree *tree);
|
|
|
|
/* Parses and returns the tree in the given ent, chasing tags and commits. */
|
|
#define parse_tree_indirect(o) repo_parse_tree_indirect(the_repository, o)
|
|
struct tree *repo_parse_tree_indirect(struct repository *r,
|
|
const struct object_id *oid);
|
|
|
|
/*
|
|
* Functions for comparing pathnames
|
|
*/
|
|
int base_name_compare(const char *name1, size_t len1, int mode1,
|
|
const char *name2, size_t len2, int mode2);
|
|
int df_name_compare(const char *name1, size_t len1, int mode1,
|
|
const char *name2, size_t len2, int mode2);
|
|
int name_compare(const char *name1, size_t len1,
|
|
const char *name2, size_t len2);
|
|
|
|
#define READ_TREE_RECURSIVE 1
|
|
typedef int (*read_tree_fn_t)(const struct object_id *, struct strbuf *, const char *, unsigned int, void *);
|
|
|
|
int read_tree_at(struct repository *r,
|
|
struct tree *tree, struct strbuf *base,
|
|
int depth,
|
|
const struct pathspec *pathspec,
|
|
read_tree_fn_t fn, void *context);
|
|
|
|
int read_tree(struct repository *r,
|
|
struct tree *tree,
|
|
const struct pathspec *pathspec,
|
|
read_tree_fn_t fn, void *context);
|
|
|
|
#endif /* TREE_H */
|