mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 22:28:38 -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>
81 lines
2.5 KiB
C
81 lines
2.5 KiB
C
#ifndef WRITE_OR_DIE_H
|
|
#define WRITE_OR_DIE_H
|
|
|
|
void maybe_flush_or_die(FILE *, const char *);
|
|
__attribute__((format (printf, 2, 3)))
|
|
void fprintf_or_die(FILE *, const char *fmt, ...);
|
|
void fwrite_or_die(FILE *f, const void *buf, size_t count);
|
|
void fflush_or_die(FILE *f);
|
|
void write_or_die(int fd, const void *buf, size_t count);
|
|
|
|
/*
|
|
* These values are used to help identify parts of a repository to fsync.
|
|
* FSYNC_COMPONENT_NONE identifies data that will not be a persistent part of the
|
|
* repository and so shouldn't be fsynced.
|
|
*/
|
|
enum fsync_component {
|
|
FSYNC_COMPONENT_NONE,
|
|
FSYNC_COMPONENT_LOOSE_OBJECT = 1 << 0,
|
|
FSYNC_COMPONENT_PACK = 1 << 1,
|
|
FSYNC_COMPONENT_PACK_METADATA = 1 << 2,
|
|
FSYNC_COMPONENT_COMMIT_GRAPH = 1 << 3,
|
|
FSYNC_COMPONENT_INDEX = 1 << 4,
|
|
FSYNC_COMPONENT_REFERENCE = 1 << 5,
|
|
FSYNC_COMPONENT_OBJECT_MAP = 1 << 6,
|
|
};
|
|
|
|
#define FSYNC_COMPONENTS_OBJECTS (FSYNC_COMPONENT_LOOSE_OBJECT | \
|
|
FSYNC_COMPONENT_PACK)
|
|
|
|
#define FSYNC_COMPONENTS_DERIVED_METADATA (FSYNC_COMPONENT_PACK_METADATA | \
|
|
FSYNC_COMPONENT_COMMIT_GRAPH)
|
|
|
|
#define FSYNC_COMPONENTS_DEFAULT ((FSYNC_COMPONENTS_OBJECTS | \
|
|
FSYNC_COMPONENTS_DERIVED_METADATA) & \
|
|
~FSYNC_COMPONENT_LOOSE_OBJECT)
|
|
|
|
#define FSYNC_COMPONENTS_COMMITTED (FSYNC_COMPONENTS_OBJECTS | \
|
|
FSYNC_COMPONENT_REFERENCE)
|
|
|
|
#define FSYNC_COMPONENTS_ADDED (FSYNC_COMPONENTS_COMMITTED | \
|
|
FSYNC_COMPONENT_INDEX)
|
|
|
|
#define FSYNC_COMPONENTS_ALL (FSYNC_COMPONENT_LOOSE_OBJECT | \
|
|
FSYNC_COMPONENT_PACK | \
|
|
FSYNC_COMPONENT_PACK_METADATA | \
|
|
FSYNC_COMPONENT_COMMIT_GRAPH | \
|
|
FSYNC_COMPONENT_INDEX | \
|
|
FSYNC_COMPONENT_REFERENCE | \
|
|
FSYNC_COMPONENT_OBJECT_MAP)
|
|
|
|
#ifndef FSYNC_COMPONENTS_PLATFORM_DEFAULT
|
|
#define FSYNC_COMPONENTS_PLATFORM_DEFAULT FSYNC_COMPONENTS_DEFAULT
|
|
#endif
|
|
|
|
/* IO helper functions */
|
|
void fsync_or_die(int fd, const char *);
|
|
int fsync_component(enum fsync_component component, int fd);
|
|
void fsync_component_or_die(enum fsync_component component, int fd, const char *msg);
|
|
|
|
/*
|
|
* A bitmask indicating which components of the repo should be fsynced.
|
|
*/
|
|
extern enum fsync_component fsync_components;
|
|
extern int fsync_object_files;
|
|
extern int use_fsync;
|
|
|
|
enum fsync_method {
|
|
FSYNC_METHOD_FSYNC,
|
|
FSYNC_METHOD_WRITEOUT_ONLY,
|
|
FSYNC_METHOD_BATCH,
|
|
};
|
|
|
|
extern enum fsync_method fsync_method;
|
|
|
|
static inline int batch_fsync_enabled(enum fsync_component component)
|
|
{
|
|
return (fsync_components & component) && (fsync_method == FSYNC_METHOD_BATCH);
|
|
}
|
|
|
|
#endif /* WRITE_OR_DIE_H */
|