mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-27 13:21:17 -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
1.5 KiB
C
64 lines
1.5 KiB
C
#ifndef ARCHIVE_H
|
|
#define ARCHIVE_H
|
|
|
|
#include "pathspec.h"
|
|
#include "string-list.h"
|
|
|
|
struct repository;
|
|
struct pretty_print_context;
|
|
|
|
struct archiver_args {
|
|
struct repository *repo;
|
|
char *refname;
|
|
const char *prefix;
|
|
const char *base;
|
|
size_t baselen;
|
|
struct tree *tree;
|
|
const struct object_id *commit_oid;
|
|
const struct commit *commit;
|
|
const char *mtime_option;
|
|
timestamp_t time;
|
|
struct pathspec pathspec;
|
|
unsigned int verbose : 1;
|
|
unsigned int worktree_attributes : 1;
|
|
unsigned int convert : 1;
|
|
int compression_level;
|
|
struct string_list extra_files;
|
|
struct pretty_print_context *pretty_ctx;
|
|
};
|
|
|
|
/* main api */
|
|
|
|
int write_archive(int argc, const char **argv, const char *prefix,
|
|
struct repository *repo,
|
|
const char *name_hint, int remote);
|
|
|
|
const char *archive_format_from_filename(const char *filename);
|
|
|
|
/* archive backend stuff */
|
|
|
|
#define ARCHIVER_WANT_COMPRESSION_LEVELS 1
|
|
#define ARCHIVER_REMOTE 2
|
|
#define ARCHIVER_HIGH_COMPRESSION_LEVELS 4
|
|
struct archiver {
|
|
const char *name;
|
|
int (*write_archive)(const struct archiver *, struct archiver_args *);
|
|
unsigned flags;
|
|
char *filter_command;
|
|
};
|
|
void register_archiver(struct archiver *);
|
|
|
|
void init_tar_archiver(void);
|
|
void init_zip_archiver(void);
|
|
void init_archivers(void);
|
|
|
|
typedef int (*write_archive_entry_fn_t)(struct archiver_args *args,
|
|
const struct object_id *oid,
|
|
const char *path, size_t pathlen,
|
|
unsigned int mode,
|
|
void *buffer, unsigned long size);
|
|
|
|
int write_archive_entries(struct archiver_args *args, write_archive_entry_fn_t write_entry);
|
|
|
|
#endif /* ARCHIVE_H */
|