mirror of
https://github.com/git/git
synced 2024-08-28 12:09:19 +00:00
![Ævar Arnfjörð Bjarmason](/assets/img/avatar_default.png)
The "--super-prefix" option to "git" was initially added in [1] for use with "ls-files"[2], and shortly thereafter "submodule--helper"[3] and "grep"[4]. It wasn't until [5] that "read-tree" made use of it. At the time [5] made sense, but since then we've made "ls-files" recurse in-process in [6], "grep" in [7], and finally "submodule--helper" in the preceding commits. Let's also remove it from "read-tree", which allows us to remove the option to "git" itself. We can do this because the only remaining user of it is the submodule API, which will now invoke "read-tree" with its new "--super-prefix" option. It will only do so when the "submodule_move_head()" function is called. That "submodule_move_head()" function was then only invoked by "read-tree" itself, but now rather than setting an environment variable to pass "--super-prefix" between cmd_read_tree() we: - Set a new "super_prefix" in "struct unpack_trees_options". The "super_prefixed()" function in "unpack-trees.c" added in [5] will now use this, rather than get_super_prefix() looking up the environment variable we set earlier in the same process. - Add the same field to the "struct checkout", which is only needed to ferry the "super_prefix" in the "struct unpack_trees_options" all the way down to the "entry.c" callers of "submodule_move_head()". Those calls which used the super prefix all originated in "cmd_read_tree()". The only other caller is the "unlink_entry()" caller in "builtin/checkout.c", which now passes a "NULL". 1.74866d7579
(git: make super-prefix option, 2016-10-07) 2.e77aa336f1
(ls-files: optionally recurse into submodules, 2016-10-07) 3.89c8626557
(submodule helper: support super prefix, 2016-12-08) 4.0281e487fd
(grep: optionally recurse into submodules, 2016-12-16) 5.3d415425c7
(unpack-trees: support super-prefix option, 2017-01-17) 6.188dce131f
(ls-files: use repository object, 2017-06-22) 7.f9ee2fcdfa
(grep: recurse in-process using 'struct repository', 2017-08-02) Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
132 lines
3.5 KiB
C
132 lines
3.5 KiB
C
#ifndef UNPACK_TREES_H
|
|
#define UNPACK_TREES_H
|
|
|
|
#include "cache.h"
|
|
#include "strvec.h"
|
|
#include "string-list.h"
|
|
#include "tree-walk.h"
|
|
|
|
#define MAX_UNPACK_TREES MAX_TRAVERSE_TREES
|
|
|
|
struct cache_entry;
|
|
struct unpack_trees_options;
|
|
struct pattern_list;
|
|
|
|
typedef int (*merge_fn_t)(const struct cache_entry * const *src,
|
|
struct unpack_trees_options *options);
|
|
|
|
enum unpack_trees_error_types {
|
|
ERROR_WOULD_OVERWRITE = 0,
|
|
ERROR_NOT_UPTODATE_FILE,
|
|
ERROR_NOT_UPTODATE_DIR,
|
|
ERROR_CWD_IN_THE_WAY,
|
|
ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
|
|
ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
|
|
ERROR_BIND_OVERLAP,
|
|
ERROR_WOULD_LOSE_SUBMODULE,
|
|
|
|
NB_UNPACK_TREES_ERROR_TYPES,
|
|
|
|
WARNING_SPARSE_NOT_UPTODATE_FILE,
|
|
WARNING_SPARSE_UNMERGED_FILE,
|
|
WARNING_SPARSE_ORPHANED_NOT_OVERWRITTEN,
|
|
|
|
NB_UNPACK_TREES_WARNING_TYPES,
|
|
};
|
|
|
|
/*
|
|
* Sets the list of user-friendly error messages to be used by the
|
|
* command "cmd" (either merge or checkout), and show_all_errors to 1.
|
|
*/
|
|
void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
|
|
const char *cmd);
|
|
|
|
/*
|
|
* Frees resources allocated by setup_unpack_trees_porcelain().
|
|
*/
|
|
void clear_unpack_trees_porcelain(struct unpack_trees_options *opts);
|
|
|
|
enum unpack_trees_reset_type {
|
|
UNPACK_RESET_NONE = 0, /* traditional "false" value; still valid */
|
|
UNPACK_RESET_INVALID = 1, /* "true" no longer valid; use below values */
|
|
UNPACK_RESET_PROTECT_UNTRACKED,
|
|
UNPACK_RESET_OVERWRITE_UNTRACKED
|
|
};
|
|
|
|
struct unpack_trees_options {
|
|
unsigned int merge,
|
|
update,
|
|
preserve_ignored,
|
|
clone,
|
|
index_only,
|
|
nontrivial_merge,
|
|
trivial_merges_only,
|
|
verbose_update,
|
|
aggressive,
|
|
skip_unmerged,
|
|
initial_checkout,
|
|
diff_index_cached,
|
|
debug_unpack,
|
|
skip_sparse_checkout,
|
|
quiet,
|
|
exiting_early,
|
|
show_all_errors,
|
|
dry_run,
|
|
skip_cache_tree_update;
|
|
enum unpack_trees_reset_type reset;
|
|
const char *prefix;
|
|
const char *super_prefix;
|
|
int cache_bottom;
|
|
struct pathspec *pathspec;
|
|
merge_fn_t fn;
|
|
const char *msgs[NB_UNPACK_TREES_WARNING_TYPES];
|
|
struct strvec msgs_to_free;
|
|
/*
|
|
* Store error messages in an array, each case
|
|
* corresponding to a error message type
|
|
*/
|
|
struct string_list unpack_rejects[NB_UNPACK_TREES_WARNING_TYPES];
|
|
|
|
int head_idx;
|
|
int merge_size;
|
|
|
|
struct cache_entry *df_conflict_entry;
|
|
void *unpack_data;
|
|
|
|
struct index_state *dst_index;
|
|
struct index_state *src_index;
|
|
struct index_state result;
|
|
|
|
struct pattern_list *pl; /* for internal use */
|
|
struct dir_struct *dir; /* for internal use only */
|
|
struct checkout_metadata meta;
|
|
};
|
|
|
|
int unpack_trees(unsigned n, struct tree_desc *t,
|
|
struct unpack_trees_options *options);
|
|
|
|
enum update_sparsity_result {
|
|
UPDATE_SPARSITY_SUCCESS = 0,
|
|
UPDATE_SPARSITY_WARNINGS = 1,
|
|
UPDATE_SPARSITY_INDEX_UPDATE_FAILURES = -1,
|
|
UPDATE_SPARSITY_WORKTREE_UPDATE_FAILURES = -2
|
|
};
|
|
|
|
enum update_sparsity_result update_sparsity(struct unpack_trees_options *options);
|
|
|
|
int verify_uptodate(const struct cache_entry *ce,
|
|
struct unpack_trees_options *o);
|
|
|
|
int threeway_merge(const struct cache_entry * const *stages,
|
|
struct unpack_trees_options *o);
|
|
int twoway_merge(const struct cache_entry * const *src,
|
|
struct unpack_trees_options *o);
|
|
int bind_merge(const struct cache_entry * const *src,
|
|
struct unpack_trees_options *o);
|
|
int oneway_merge(const struct cache_entry * const *src,
|
|
struct unpack_trees_options *o);
|
|
int stash_worktree_untracked_merge(const struct cache_entry * const *src,
|
|
struct unpack_trees_options *o);
|
|
|
|
#endif
|