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>
49 lines
1.6 KiB
C
49 lines
1.6 KiB
C
#ifndef REFS_PACKED_BACKEND_H
|
|
#define REFS_PACKED_BACKEND_H
|
|
|
|
struct repository;
|
|
struct ref_transaction;
|
|
struct ref_store_init_options;
|
|
|
|
/*
|
|
* Support for storing references in a `packed-refs` file.
|
|
*
|
|
* Note that this backend doesn't check for D/F conflicts, because it
|
|
* doesn't care about them. But usually it should be wrapped in a
|
|
* `files_ref_store` that prevents D/F conflicts from being created,
|
|
* even among packed refs.
|
|
*/
|
|
|
|
struct ref_store *packed_ref_store_init(struct repository *repo,
|
|
const char *payload,
|
|
const char *gitdir,
|
|
const struct ref_store_init_options *options);
|
|
|
|
/*
|
|
* Lock the packed-refs file for writing. Flags is passed to
|
|
* hold_lock_file_for_update(). Return 0 on success. On errors, write
|
|
* an error message to `err` and return a nonzero value.
|
|
*/
|
|
int packed_refs_lock(struct ref_store *ref_store, int flags, struct strbuf *err);
|
|
|
|
void packed_refs_unlock(struct ref_store *ref_store);
|
|
int packed_refs_is_locked(struct ref_store *ref_store);
|
|
|
|
/*
|
|
* Obtain the size of the `packed-refs` file. Reports `0` as size in case there
|
|
* is no packed-refs file. Returns 0 on success, negative otherwise.
|
|
*/
|
|
int packed_refs_size(struct ref_store *ref_store,
|
|
size_t *out);
|
|
|
|
/*
|
|
* Return true if `transaction` really needs to be carried out against
|
|
* the specified packed_ref_store, or false if it can be skipped
|
|
* (i.e., because it is an obvious NOOP). `ref_store` must be locked
|
|
* before calling this function.
|
|
*/
|
|
int is_packed_transaction_needed(struct ref_store *ref_store,
|
|
struct ref_transaction *transaction);
|
|
|
|
#endif /* REFS_PACKED_BACKEND_H */
|