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>
75 lines
2.3 KiB
C
75 lines
2.3 KiB
C
#ifndef BUNDLE_H
|
|
#define BUNDLE_H
|
|
|
|
#include "strvec.h"
|
|
#include "string-list.h"
|
|
#include "list-objects-filter-options.h"
|
|
|
|
struct bundle_header {
|
|
unsigned version;
|
|
struct string_list prerequisites;
|
|
struct string_list references;
|
|
const struct git_hash_algo *hash_algo;
|
|
struct list_objects_filter_options filter;
|
|
};
|
|
|
|
#define BUNDLE_HEADER_INIT \
|
|
{ \
|
|
.prerequisites = STRING_LIST_INIT_DUP, \
|
|
.references = STRING_LIST_INIT_DUP, \
|
|
.filter = LIST_OBJECTS_FILTER_INIT, \
|
|
}
|
|
void bundle_header_init(struct bundle_header *header);
|
|
void bundle_header_release(struct bundle_header *header);
|
|
|
|
int is_bundle(const char *path, int quiet);
|
|
int read_bundle_header(const char *path, struct bundle_header *header);
|
|
int read_bundle_header_fd(int fd, struct bundle_header *header,
|
|
const char *report_path);
|
|
int create_bundle(struct repository *r, const char *path,
|
|
int argc, const char **argv, struct strvec *pack_options,
|
|
int version);
|
|
|
|
enum verify_bundle_flags {
|
|
VERIFY_BUNDLE_VERBOSE = (1 << 0),
|
|
VERIFY_BUNDLE_QUIET = (1 << 1),
|
|
VERIFY_BUNDLE_FSCK = (1 << 2),
|
|
};
|
|
|
|
int verify_bundle(struct repository *r, struct bundle_header *header,
|
|
enum verify_bundle_flags flags);
|
|
|
|
struct unbundle_opts {
|
|
enum verify_bundle_flags flags;
|
|
/*
|
|
* fsck_msg_types may optionally contain fsck message severity
|
|
* configuration. If present, this configuration gets directly appended
|
|
* to a '--fsck-objects' option and therefore must be prefixed with '='.
|
|
* (E.g. "=missingEmail=ignore,gitmodulesUrl=ignore")
|
|
*/
|
|
const char *fsck_msg_types;
|
|
};
|
|
|
|
/**
|
|
* Unbundle after reading the header with read_bundle_header().
|
|
*
|
|
* We'll invoke "git index-pack --stdin --fix-thin" for you on the
|
|
* provided `bundle_fd` from read_bundle_header().
|
|
*
|
|
* Provide "extra_index_pack_args" to pass any extra arguments
|
|
* (e.g. "-v" for verbose/progress), NULL otherwise. The provided
|
|
* "extra_index_pack_args" (if any) will be strvec_clear()'d for you.
|
|
*
|
|
* Before unbundling, this method will call verify_bundle() with 'flags'
|
|
* provided in 'opts'.
|
|
*
|
|
* Note that the `bundle_fd` will be closed as part of the operation.
|
|
*/
|
|
int unbundle(struct repository *r, struct bundle_header *header,
|
|
int bundle_fd, struct strvec *extra_index_pack_args,
|
|
struct unbundle_opts *opts);
|
|
int list_bundle_refs(struct bundle_header *header,
|
|
int argc, const char **argv);
|
|
|
|
#endif
|