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>
55 lines
1.8 KiB
C
55 lines
1.8 KiB
C
#ifndef FSMONITOR_SETTINGS_H
|
|
#define FSMONITOR_SETTINGS_H
|
|
|
|
struct repository;
|
|
|
|
enum fsmonitor_mode {
|
|
FSMONITOR_MODE_INCOMPATIBLE = -1, /* see _reason */
|
|
FSMONITOR_MODE_DISABLED = 0,
|
|
FSMONITOR_MODE_HOOK = 1, /* core.fsmonitor=<hook_path> */
|
|
FSMONITOR_MODE_IPC = 2, /* core.fsmonitor=<true> */
|
|
};
|
|
|
|
/*
|
|
* Incompatibility reasons.
|
|
*/
|
|
enum fsmonitor_reason {
|
|
FSMONITOR_REASON_UNTESTED = 0,
|
|
FSMONITOR_REASON_OK, /* no incompatibility or when disabled */
|
|
FSMONITOR_REASON_BARE,
|
|
FSMONITOR_REASON_ERROR, /* FS error probing for compatibility */
|
|
FSMONITOR_REASON_REMOTE,
|
|
FSMONITOR_REASON_VFS4GIT, /* VFS for Git virtualization */
|
|
FSMONITOR_REASON_NOSOCKETS, /* NTFS,FAT32 do not support Unix sockets */
|
|
};
|
|
|
|
void fsm_settings__set_ipc(struct repository *r);
|
|
void fsm_settings__set_hook(struct repository *r, const char *path);
|
|
void fsm_settings__set_disabled(struct repository *r);
|
|
void fsm_settings__set_incompatible(struct repository *r,
|
|
enum fsmonitor_reason reason);
|
|
|
|
enum fsmonitor_mode fsm_settings__get_mode(struct repository *r);
|
|
const char *fsm_settings__get_hook_path(struct repository *r);
|
|
|
|
enum fsmonitor_reason fsm_settings__get_reason(struct repository *r);
|
|
char *fsm_settings__get_incompatible_msg(struct repository *r,
|
|
enum fsmonitor_reason reason);
|
|
|
|
struct fsmonitor_settings;
|
|
|
|
#ifdef HAVE_FSMONITOR_OS_SETTINGS
|
|
/*
|
|
* Ask platform-specific code whether the repository is incompatible
|
|
* with fsmonitor (both hook and ipc modes). For example, if the working
|
|
* directory is on a remote volume and mounted via a technology that does
|
|
* not support notification events, then we should not pretend to watch it.
|
|
*
|
|
* fsm_os__* routines should considered private to fsm_settings__
|
|
* routines.
|
|
*/
|
|
enum fsmonitor_reason fsm_os__incompatible(struct repository *r, int ipc);
|
|
#endif /* HAVE_FSMONITOR_OS_SETTINGS */
|
|
|
|
#endif /* FSMONITOR_SETTINGS_H */
|