mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 21:51: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>
61 lines
1.4 KiB
C
61 lines
1.4 KiB
C
#ifndef FSM_PATH_UTILS_H
|
|
#define FSM_PATH_UTILS_H
|
|
|
|
#include "strbuf.h"
|
|
|
|
struct alias_info
|
|
{
|
|
struct strbuf alias;
|
|
struct strbuf points_to;
|
|
};
|
|
|
|
struct fs_info {
|
|
int is_remote;
|
|
char *typename;
|
|
};
|
|
|
|
/*
|
|
* Get some basic filesystem information for the given path
|
|
*
|
|
* The caller owns the storage that is occupied by fs_info and
|
|
* is responsible for releasing it.
|
|
*
|
|
* Returns -1 on error, zero otherwise.
|
|
*/
|
|
int fsmonitor__get_fs_info(const char *path, struct fs_info *fs_info);
|
|
|
|
/*
|
|
* Determines if the filesystem that path resides on is remote.
|
|
*
|
|
* Returns -1 on error, 0 if not remote, 1 if remote.
|
|
*/
|
|
int fsmonitor__is_fs_remote(const char *path);
|
|
|
|
/*
|
|
* Get the alias in given path, if any.
|
|
*
|
|
* Sets alias to the first alias that matches any part of the path.
|
|
*
|
|
* If an alias is found, info.alias and info.points_to are set to the
|
|
* found mapping.
|
|
*
|
|
* Returns -1 on error, 0 otherwise.
|
|
*
|
|
* The caller owns the storage that is occupied by info.alias and
|
|
* info.points_to and is responsible for releasing it.
|
|
*/
|
|
int fsmonitor__get_alias(const char *path, struct alias_info *info);
|
|
|
|
/*
|
|
* Resolve the path against the given alias.
|
|
*
|
|
* Returns the resolved path if there is one, NULL otherwise.
|
|
*
|
|
* The caller owns the storage that the returned string occupies and
|
|
* is responsible for releasing it.
|
|
*/
|
|
char *fsmonitor__resolve_alias(const char *path,
|
|
const struct alias_info *info);
|
|
|
|
#endif
|