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>
72 lines
2.2 KiB
C
72 lines
2.2 KiB
C
#ifndef ENTRY_H
|
|
#define ENTRY_H
|
|
|
|
#include "convert.h"
|
|
|
|
struct cache_entry;
|
|
struct index_state;
|
|
|
|
struct checkout {
|
|
struct index_state *istate;
|
|
const char *base_dir;
|
|
int base_dir_len;
|
|
const char *super_prefix;
|
|
struct delayed_checkout *delayed_checkout;
|
|
struct checkout_metadata meta;
|
|
unsigned force:1,
|
|
quiet:1,
|
|
not_new:1,
|
|
clone:1,
|
|
refresh_cache:1;
|
|
};
|
|
#define CHECKOUT_INIT { .base_dir = "" }
|
|
|
|
#define TEMPORARY_FILENAME_LENGTH 25
|
|
/*
|
|
* Write the contents from ce out to the working tree.
|
|
*
|
|
* When topath[] is not NULL, instead of writing to the working tree
|
|
* file named by ce, a temporary file is created by this function and
|
|
* its name is returned in topath[], which must be able to hold at
|
|
* least TEMPORARY_FILENAME_LENGTH bytes long.
|
|
*
|
|
* With checkout_entry_ca(), callers can optionally pass a preloaded
|
|
* conv_attrs struct (to avoid reloading it), when ce refers to a
|
|
* regular file. If ca is NULL, the attributes will be loaded
|
|
* internally when (and if) needed.
|
|
*/
|
|
int checkout_entry_ca(struct cache_entry *ce, struct conv_attrs *ca,
|
|
const struct checkout *state, char *topath,
|
|
int *nr_checkouts);
|
|
static inline int checkout_entry(struct cache_entry *ce,
|
|
const struct checkout *state, char *topath,
|
|
int *nr_checkouts)
|
|
{
|
|
return checkout_entry_ca(ce, NULL, state, topath, nr_checkouts);
|
|
}
|
|
|
|
void enable_delayed_checkout(struct checkout *state);
|
|
int finish_delayed_checkout(struct checkout *state, int show_progress);
|
|
|
|
/*
|
|
* Unlink the last component and schedule the leading directories for
|
|
* removal, such that empty directories get removed.
|
|
*
|
|
* The "super_prefix" is either NULL, or the "--super-prefix" passed
|
|
* down from "read-tree" et al.
|
|
*/
|
|
void unlink_entry(const struct cache_entry *ce, const char *super_prefix);
|
|
|
|
void *read_blob_entry(const struct cache_entry *ce, size_t *size);
|
|
int fstat_checkout_output(int fd, const struct checkout *state, struct stat *st);
|
|
void update_ce_after_write(const struct checkout *state, struct cache_entry *ce,
|
|
struct stat *st);
|
|
|
|
/*
|
|
* Calls the correct function out of {unlink,rmdir}_or_warn based on
|
|
* the supplied file mode.
|
|
*/
|
|
int remove_or_warn(unsigned int mode, const char *path);
|
|
|
|
#endif /* ENTRY_H */
|