mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 11:47:49 -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>
36 lines
1.2 KiB
C
36 lines
1.2 KiB
C
#ifndef EDITOR_H
|
|
#define EDITOR_H
|
|
|
|
struct repository;
|
|
struct strbuf;
|
|
|
|
const char *git_editor(void);
|
|
const char *git_sequence_editor(void);
|
|
int is_terminal_dumb(void);
|
|
|
|
/**
|
|
* Launch the user preferred editor to edit a file and fill the buffer
|
|
* with the file's contents upon the user completing their editing. The
|
|
* third argument can be used to set the environment which the editor is
|
|
* run in. If the buffer is NULL the editor is launched as usual but the
|
|
* file's contents are not read into the buffer upon completion.
|
|
*/
|
|
int launch_editor(const char *path, struct strbuf *buffer,
|
|
const char *const *env);
|
|
|
|
int launch_sequence_editor(const char *path, struct strbuf *buffer,
|
|
const char *const *env);
|
|
|
|
/*
|
|
* In contrast to `launch_editor()`, this function writes out the contents
|
|
* of the specified file first, then clears the `buffer`, then launches
|
|
* the editor and reads back in the file contents into the `buffer`.
|
|
* Finally, it deletes the temporary file.
|
|
*
|
|
* If `path` is relative, it refers to a file in the `.git` directory.
|
|
*/
|
|
int strbuf_edit_interactively(struct repository *r, struct strbuf *buffer,
|
|
const char *path, const char *const *env);
|
|
|
|
#endif
|