mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 00:58:30 -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>
64 lines
2.1 KiB
C
64 lines
2.1 KiB
C
#ifndef REPLACE_OBJECT_H
|
|
#define REPLACE_OBJECT_H
|
|
|
|
#include "oidmap.h"
|
|
#include "repository.h"
|
|
#include "odb.h"
|
|
|
|
struct replace_object {
|
|
struct oidmap_entry original;
|
|
struct object_id replacement;
|
|
};
|
|
|
|
void prepare_replace_object(struct repository *r);
|
|
|
|
/*
|
|
* This internal function is only declared here for the benefit of
|
|
* lookup_replace_object(). Please do not call it directly.
|
|
*/
|
|
const struct object_id *do_lookup_replace_object(struct repository *r,
|
|
const struct object_id *oid);
|
|
|
|
/*
|
|
* Some commands disable replace-refs unconditionally, and otherwise each
|
|
* repository could alter the core.useReplaceRefs config value.
|
|
*
|
|
* Return 1 if and only if all of the following are true:
|
|
*
|
|
* a. disable_replace_refs() has not been called.
|
|
* b. GIT_NO_REPLACE_OBJECTS is unset or zero.
|
|
* c. the given repository does not have core.useReplaceRefs=false.
|
|
*/
|
|
int replace_refs_enabled(struct repository *r);
|
|
|
|
/*
|
|
* If object sha1 should be replaced, return the replacement object's
|
|
* name (replaced recursively, if necessary). The return value is
|
|
* either sha1 or a pointer to a permanently-allocated value. When
|
|
* object replacement is suppressed, always return sha1.
|
|
*
|
|
* Note: some thread debuggers might point a data race on the
|
|
* replace_map_initialized reading in this function. However, we know there's no
|
|
* problem in the value being updated by one thread right after another one read
|
|
* it here (and it should be written to only once, anyway).
|
|
*/
|
|
static inline const struct object_id *lookup_replace_object(struct repository *r,
|
|
const struct object_id *oid)
|
|
{
|
|
if (!replace_refs_enabled(r) ||
|
|
(r->objects->replace_map_initialized &&
|
|
oidmap_get_size(&r->objects->replace_map) == 0))
|
|
return oid;
|
|
return do_lookup_replace_object(r, oid);
|
|
}
|
|
|
|
/*
|
|
* Some commands override config and environment settings for using
|
|
* replace references. Use this method to disable the setting and ensure
|
|
* those other settings will not override this choice. This applies
|
|
* globally to all in-process repositories.
|
|
*/
|
|
void disable_replace_refs(void);
|
|
|
|
#endif /* REPLACE_OBJECT_H */
|