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>
54 lines
1.6 KiB
C
54 lines
1.6 KiB
C
#ifndef LINE_LOG_H
|
|
#define LINE_LOG_H
|
|
|
|
#include "diffcore.h" /* struct range, struct range_set */
|
|
|
|
struct rev_info;
|
|
struct commit;
|
|
struct string_list;
|
|
|
|
/* A diff, encoded as the set of pre- and post-image ranges where the
|
|
* files differ. A pair of ranges corresponds to a hunk. */
|
|
struct diff_ranges {
|
|
struct range_set parent;
|
|
struct range_set target;
|
|
};
|
|
|
|
void range_set_init(struct range_set *, size_t prealloc);
|
|
void range_set_release(struct range_set *);
|
|
/* Range includes start; excludes end */
|
|
void range_set_append_unsafe(struct range_set *, long start, long end);
|
|
/* New range must begin at or after end of last added range */
|
|
void range_set_append(struct range_set *, long start, long end);
|
|
/*
|
|
* In-place pass of sorting and merging the ranges in the range set,
|
|
* to sort and make the ranges disjoint.
|
|
*/
|
|
void sort_and_merge_range_set(struct range_set *);
|
|
|
|
/* Linked list of interesting files and their associated ranges. The
|
|
* list must be kept sorted by path.
|
|
*
|
|
* For simplicity, even though this is highly redundant, each
|
|
* line_log_data owns its 'path'.
|
|
*/
|
|
struct line_log_data {
|
|
struct line_log_data *next;
|
|
char *path;
|
|
struct range_set ranges;
|
|
struct diff_filepair *pair;
|
|
struct diff_ranges diff;
|
|
};
|
|
|
|
void line_log_init(struct rev_info *rev, const char *prefix, struct string_list *args);
|
|
|
|
int line_log_filter(struct rev_info *rev);
|
|
int line_log_process_ranges_arbitrary_commit(struct rev_info *rev,
|
|
struct commit *commit);
|
|
|
|
void line_log_queue_pairs(struct rev_info *rev, struct commit *commit);
|
|
|
|
void line_log_free(struct rev_info *rev);
|
|
|
|
#endif /* LINE_LOG_H */
|