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>
56 lines
1.5 KiB
C
56 lines
1.5 KiB
C
#ifndef NOTES_UTILS_H
|
|
#define NOTES_UTILS_H
|
|
|
|
#include "notes.h"
|
|
|
|
struct commit_list;
|
|
struct object_id;
|
|
struct repository;
|
|
|
|
/*
|
|
* Create new notes commit from the given notes tree
|
|
*
|
|
* Properties of the created commit:
|
|
* - tree: the result of converting t to a tree object with write_notes_tree().
|
|
* - parents: the given parents OR (if NULL) the commit referenced by t->ref.
|
|
* - author/committer: the default determined by commit_tree().
|
|
* - commit message: msg
|
|
*
|
|
* The resulting commit SHA1 is stored in result_sha1.
|
|
*/
|
|
void create_notes_commit(struct repository *r,
|
|
struct notes_tree *t,
|
|
const struct commit_list *parents,
|
|
const char *msg, size_t msg_len,
|
|
struct object_id *result_oid);
|
|
|
|
void commit_notes(struct repository *r, struct notes_tree *t, const char *msg);
|
|
|
|
enum notes_merge_strategy {
|
|
NOTES_MERGE_RESOLVE_MANUAL = 0,
|
|
NOTES_MERGE_RESOLVE_OURS,
|
|
NOTES_MERGE_RESOLVE_THEIRS,
|
|
NOTES_MERGE_RESOLVE_UNION,
|
|
NOTES_MERGE_RESOLVE_CAT_SORT_UNIQ
|
|
};
|
|
|
|
struct notes_rewrite_cfg {
|
|
struct notes_tree **trees;
|
|
const char *cmd;
|
|
int enabled;
|
|
combine_notes_fn combine;
|
|
struct string_list *refs;
|
|
int refs_from_env;
|
|
int mode_from_env;
|
|
};
|
|
|
|
int parse_notes_merge_strategy(const char *v, enum notes_merge_strategy *s);
|
|
struct notes_rewrite_cfg *init_copy_notes_for_rewrite(const char *cmd);
|
|
int copy_note_for_rewrite(struct notes_rewrite_cfg *c,
|
|
const struct object_id *from_obj, const struct object_id *to_obj);
|
|
void finish_copy_notes_for_rewrite(struct repository *r,
|
|
struct notes_rewrite_cfg *c,
|
|
const char *msg);
|
|
|
|
#endif
|