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>
42 lines
1.4 KiB
C
42 lines
1.4 KiB
C
#ifndef LINE_RANGE_H
|
|
#define LINE_RANGE_H
|
|
|
|
struct index_state;
|
|
|
|
/*
|
|
* Parse one item in an -L begin,end option w.r.t. the notional file
|
|
* object 'cb_data' consisting of 'lines' lines.
|
|
*
|
|
* The 'nth_line_cb' callback is used to determine the start of the
|
|
* line 'lno' inside the 'cb_data'. The caller is expected to already
|
|
* have a suitable map at hand to make this a constant-time lookup.
|
|
*
|
|
* 'anchor' is the 1-based line at which relative range specifications
|
|
* should be anchored. Absolute ranges are unaffected by this value.
|
|
*
|
|
* Returns 0 in case of success and -1 if there was an error. The
|
|
* actual range is stored in *begin and *end. The counting starts
|
|
* at 1! In case of error, the caller should show usage message.
|
|
*/
|
|
|
|
typedef const char *(*nth_line_fn_t)(void *data, long lno);
|
|
|
|
int parse_range_arg(const char *arg,
|
|
nth_line_fn_t nth_line_cb,
|
|
void *cb_data, long lines, long anchor,
|
|
long *begin, long *end,
|
|
const char *path, struct index_state *istate);
|
|
|
|
/*
|
|
* Scan past a range argument that could be parsed by
|
|
* 'parse_range_arg', to help the caller determine the start of the
|
|
* filename in '-L n,m:file' syntax.
|
|
*
|
|
* Returns a pointer to the first character after the 'n,m' part, or
|
|
* NULL in case the argument is obviously malformed.
|
|
*/
|
|
|
|
const char *skip_range_arg(const char *arg, struct index_state *istate);
|
|
|
|
#endif /* LINE_RANGE_H */
|