mirror of
https://github.com/git-for-windows/git.git
synced 2026-06-28 18:55:47 -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>
88 lines
2.9 KiB
C
88 lines
2.9 KiB
C
#ifndef NOTES_MERGE_H
|
|
#define NOTES_MERGE_H
|
|
|
|
#include "notes-utils.h"
|
|
#include "strbuf.h"
|
|
|
|
struct commit;
|
|
struct object_id;
|
|
struct repository;
|
|
|
|
#define NOTES_MERGE_WORKTREE "NOTES_MERGE_WORKTREE"
|
|
|
|
enum notes_merge_verbosity {
|
|
NOTES_MERGE_VERBOSITY_DEFAULT = 2,
|
|
NOTES_MERGE_VERBOSITY_MAX = 5
|
|
};
|
|
|
|
struct notes_merge_options {
|
|
struct repository *repo;
|
|
const char *local_ref;
|
|
const char *remote_ref;
|
|
struct strbuf commit_msg;
|
|
int verbosity;
|
|
enum notes_merge_strategy strategy;
|
|
unsigned has_worktree:1;
|
|
};
|
|
|
|
void init_notes_merge_options(struct repository *r,
|
|
struct notes_merge_options *o);
|
|
|
|
/*
|
|
* Merge notes from o->remote_ref into o->local_ref
|
|
*
|
|
* The given notes_tree 'local_tree' must be the notes_tree referenced by the
|
|
* o->local_ref. This is the notes_tree in which the object-level merge is
|
|
* performed.
|
|
*
|
|
* The commits given by the two refs are merged, producing one of the following
|
|
* outcomes:
|
|
*
|
|
* 1. The merge trivially results in an existing commit (e.g. fast-forward or
|
|
* already-up-to-date). 'local_tree' is untouched, the OID of the result
|
|
* is written into 'result_oid' and 0 is returned.
|
|
* 2. The merge successfully completes, producing a merge commit. local_tree
|
|
* contains the updated notes tree, the OID of the resulting commit is
|
|
* written into 'result_oid', and 1 is returned.
|
|
* 3. The merge results in conflicts. This is similar to #2 in that the
|
|
* partial merge result (i.e. merge result minus the unmerged entries)
|
|
* are stored in 'local_tree', and the OID or the resulting commit
|
|
* (to be amended when the conflicts have been resolved) is written into
|
|
* 'result_oid'. The unmerged entries are written into the
|
|
* .git/NOTES_MERGE_WORKTREE directory with conflict markers.
|
|
* -1 is returned.
|
|
*
|
|
* Both o->local_ref and o->remote_ref must be given (non-NULL), but either ref
|
|
* (although not both) may refer to a non-existing notes ref, in which case
|
|
* that notes ref is interpreted as an empty notes tree, and the merge
|
|
* trivially results in what the other ref points to.
|
|
*/
|
|
int notes_merge(struct notes_merge_options *o,
|
|
struct notes_tree *local_tree,
|
|
struct object_id *result_oid);
|
|
|
|
/*
|
|
* Finalize conflict resolution from an earlier notes_merge()
|
|
*
|
|
* The given notes tree 'partial_tree' must be the notes_tree corresponding to
|
|
* the given 'partial_commit', the partial result commit created by a previous
|
|
* call to notes_merge().
|
|
*
|
|
* This function will add the (now resolved) notes in .git/NOTES_MERGE_WORKTREE
|
|
* to 'partial_tree', and create a final notes merge commit, the OID of which
|
|
* will be stored in 'result_oid'.
|
|
*/
|
|
int notes_merge_commit(struct notes_merge_options *o,
|
|
struct notes_tree *partial_tree,
|
|
struct commit *partial_commit,
|
|
struct object_id *result_oid);
|
|
|
|
/*
|
|
* Abort conflict resolution from an earlier notes_merge()
|
|
*
|
|
* Removes the notes merge worktree in .git/NOTES_MERGE_WORKTREE.
|
|
*/
|
|
int notes_merge_abort(struct notes_merge_options *o);
|
|
|
|
#endif
|