global: introduce `USE_THE_REPOSITORY_VARIABLE` macro
Use of the `the_repository` variable is deprecated nowadays, and we
slowly but steadily convert the codebase to not use it anymore. Instead,
callers should be passing down the repository to work on via parameters.
It is hard though to prove that a given code unit does not use this
variable anymore. The most trivial case, merely demonstrating that there
is no direct use of `the_repository`, is already a bit of a pain during
code reviews as the reviewer needs to manually verify claims made by the
patch author. The bigger problem though is that we have many interfaces
that implicitly rely on `the_repository`.
Introduce a new `USE_THE_REPOSITORY_VARIABLE` macro that allows code
units to opt into usage of `the_repository`. The intent of this macro is
to demonstrate that a certain code unit does not use this variable
anymore, and to keep it from new dependencies on it in future changes,
be it explicit or implicit
For now, the macro only guards `the_repository` itself as well as
`the_hash_algo`. There are many more known interfaces where we have an
implicit dependency on `the_repository`, but those are not guarded at
the current point in time. Over time though, we should start to add
guards as required (or even better, just remove them).
Define the macro as required in our code units. As expected, most of our
code still relies on the global variable. Nearly all of our builtins
rely on the variable as there is no way yet to pass `the_repository` to
their entry point. For now, declare the macro in "biultin.h" to keep the
required changes at least a little bit more contained.
Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2024-06-14 14:50:23 +08:00
|
|
|
#define USE_THE_REPOSITORY_VARIABLE
|
|
|
|
|
2020-04-07 22:28:00 +08:00
|
|
|
#include "git-compat-util.h"
|
|
|
|
#include "cache-tree.h"
|
2023-03-21 14:25:54 +08:00
|
|
|
#include "gettext.h"
|
2023-02-24 08:09:27 +08:00
|
|
|
#include "hex.h"
|
2020-04-07 22:28:00 +08:00
|
|
|
#include "lockfile.h"
|
2023-04-11 15:41:49 +08:00
|
|
|
#include "object-name.h"
|
2020-04-07 22:28:00 +08:00
|
|
|
#include "refs.h"
|
|
|
|
#include "reset.h"
|
|
|
|
#include "tree-walk.h"
|
|
|
|
#include "tree.h"
|
|
|
|
#include "unpack-trees.h"
|
2021-12-22 11:59:35 +08:00
|
|
|
#include "hook.h"
|
2020-04-07 22:28:00 +08:00
|
|
|
|
2022-01-26 21:05:46 +08:00
|
|
|
static int update_refs(const struct reset_head_opts *opts,
|
|
|
|
const struct object_id *oid,
|
|
|
|
const struct object_id *head)
|
2020-04-07 22:28:00 +08:00
|
|
|
{
|
2022-01-26 21:05:46 +08:00
|
|
|
unsigned detach_head = opts->flags & RESET_HEAD_DETACH;
|
|
|
|
unsigned run_hook = opts->flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
|
|
|
|
unsigned update_orig_head = opts->flags & RESET_ORIG_HEAD;
|
2022-01-26 21:05:48 +08:00
|
|
|
const struct object_id *orig_head = opts->orig_head;
|
2022-01-26 21:05:46 +08:00
|
|
|
const char *switch_to_branch = opts->branch;
|
2022-01-26 21:05:47 +08:00
|
|
|
const char *reflog_branch = opts->branch_msg;
|
2022-01-26 21:05:46 +08:00
|
|
|
const char *reflog_head = opts->head_msg;
|
|
|
|
const char *reflog_orig_head = opts->orig_head_msg;
|
|
|
|
const char *default_reflog_action = opts->default_reflog_action;
|
2022-01-26 21:05:42 +08:00
|
|
|
struct object_id *old_orig = NULL, oid_old_orig;
|
|
|
|
struct strbuf msg = STRBUF_INIT;
|
|
|
|
const char *reflog_action;
|
|
|
|
size_t prefix_len;
|
|
|
|
int ret;
|
|
|
|
|
2022-01-26 21:05:43 +08:00
|
|
|
if ((update_orig_head && !reflog_orig_head) || !reflog_head) {
|
|
|
|
if (!default_reflog_action)
|
|
|
|
BUG("default_reflog_action must be given when reflog messages are omitted");
|
|
|
|
reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
|
|
|
|
strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action :
|
|
|
|
default_reflog_action);
|
|
|
|
}
|
2022-01-26 21:05:42 +08:00
|
|
|
prefix_len = msg.len;
|
|
|
|
|
|
|
|
if (update_orig_head) {
|
2023-03-28 21:58:46 +08:00
|
|
|
if (!repo_get_oid(the_repository, "ORIG_HEAD", &oid_old_orig))
|
2022-01-26 21:05:42 +08:00
|
|
|
old_orig = &oid_old_orig;
|
|
|
|
if (head) {
|
|
|
|
if (!reflog_orig_head) {
|
|
|
|
strbuf_addstr(&msg, "updating ORIG_HEAD");
|
|
|
|
reflog_orig_head = msg.buf;
|
|
|
|
}
|
2024-05-07 15:11:53 +08:00
|
|
|
refs_update_ref(get_main_ref_store(the_repository),
|
|
|
|
reflog_orig_head, "ORIG_HEAD",
|
|
|
|
orig_head ? orig_head : head,
|
|
|
|
old_orig, 0, UPDATE_REFS_MSG_ON_ERR);
|
2022-01-26 21:05:42 +08:00
|
|
|
} else if (old_orig)
|
2024-05-07 15:11:53 +08:00
|
|
|
refs_delete_ref(get_main_ref_store(the_repository),
|
|
|
|
NULL, "ORIG_HEAD", old_orig, 0);
|
2022-01-26 21:05:42 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!reflog_head) {
|
|
|
|
strbuf_setlen(&msg, prefix_len);
|
|
|
|
strbuf_addstr(&msg, "updating HEAD");
|
|
|
|
reflog_head = msg.buf;
|
|
|
|
}
|
|
|
|
if (!switch_to_branch)
|
2024-05-07 15:11:53 +08:00
|
|
|
ret = refs_update_ref(get_main_ref_store(the_repository),
|
|
|
|
reflog_head, "HEAD", oid, head,
|
|
|
|
detach_head ? REF_NO_DEREF : 0,
|
|
|
|
UPDATE_REFS_MSG_ON_ERR);
|
2022-01-26 21:05:42 +08:00
|
|
|
else {
|
2024-05-07 15:11:53 +08:00
|
|
|
ret = refs_update_ref(get_main_ref_store(the_repository),
|
|
|
|
reflog_branch ? reflog_branch : reflog_head,
|
|
|
|
switch_to_branch, oid, NULL, 0,
|
|
|
|
UPDATE_REFS_MSG_ON_ERR);
|
2022-01-26 21:05:42 +08:00
|
|
|
if (!ret)
|
2024-05-21 02:20:04 +08:00
|
|
|
ret = refs_update_symref(get_main_ref_store(the_repository),
|
2024-05-07 15:11:53 +08:00
|
|
|
"HEAD", switch_to_branch,
|
|
|
|
reflog_head);
|
2022-01-26 21:05:42 +08:00
|
|
|
}
|
|
|
|
if (!ret && run_hook)
|
2024-08-13 17:13:28 +08:00
|
|
|
run_hooks_l(the_repository, "post-checkout",
|
2022-01-26 21:05:42 +08:00
|
|
|
oid_to_hex(head ? head : null_oid()),
|
|
|
|
oid_to_hex(oid), "1", NULL);
|
|
|
|
strbuf_release(&msg);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2022-01-26 21:05:46 +08:00
|
|
|
int reset_head(struct repository *r, const struct reset_head_opts *opts)
|
2020-04-07 22:28:00 +08:00
|
|
|
{
|
2022-01-26 21:05:46 +08:00
|
|
|
const struct object_id *oid = opts->oid;
|
|
|
|
const char *switch_to_branch = opts->branch;
|
|
|
|
unsigned reset_hard = opts->flags & RESET_HEAD_HARD;
|
|
|
|
unsigned refs_only = opts->flags & RESET_HEAD_REFS_ONLY;
|
|
|
|
unsigned update_orig_head = opts->flags & RESET_ORIG_HEAD;
|
2022-01-26 21:05:38 +08:00
|
|
|
struct object_id *head = NULL, head_oid;
|
2020-04-07 22:28:00 +08:00
|
|
|
struct tree_desc desc[2] = { { NULL }, { NULL } };
|
|
|
|
struct lock_file lock = LOCK_INIT;
|
2021-07-25 21:08:30 +08:00
|
|
|
struct unpack_trees_options unpack_tree_opts = { 0 };
|
2020-04-07 22:28:00 +08:00
|
|
|
struct tree *tree;
|
2022-01-26 21:05:42 +08:00
|
|
|
const char *action;
|
2020-04-07 22:28:00 +08:00
|
|
|
int ret = 0, nr = 0;
|
|
|
|
|
|
|
|
if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
|
|
|
|
BUG("Not a fully qualified branch: '%s'", switch_to_branch);
|
|
|
|
|
2022-01-26 21:05:47 +08:00
|
|
|
if (opts->orig_head_msg && !update_orig_head)
|
|
|
|
BUG("ORIG_HEAD reflog message given without updating ORIG_HEAD");
|
|
|
|
|
|
|
|
if (opts->branch_msg && !opts->branch)
|
|
|
|
BUG("branch reflog message given without a branch");
|
|
|
|
|
2020-04-07 22:28:00 +08:00
|
|
|
if (!refs_only && repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
|
|
|
|
ret = -1;
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
libs: use "struct repository *" argument, not "the_repository"
As can easily be seen from grepping in our sources, we had these uses
of "the_repository" in various library code in cases where the
function in question was already getting a "struct repository *"
argument. Let's use that argument instead.
Out of these changes only the changes to "cache-tree.c",
"commit-reach.c", "shallow.c" and "upload-pack.c" would have cleanly
applied before the migration away from the "repo_*()" wrapper macros
in the preceding commits.
The rest aren't new, as we'd previously implicitly refer to
"the_repository", but it's now more obvious that we were doing the
wrong thing all along, and should have used the parameter instead.
The change to change "get_index_format_default(the_repository)" in
"read-cache.c" to use the "r" variable instead should arguably have
been part of [1], or in the subsequent cleanup in [2]. Let's do it
here, as can be seen from the initial code in [3] it's not important
that we use "the_repository" there, but would prefer to always use the
current repository.
This change excludes the "the_repository" use in "upload-pack.c"'s
upload_pack_advertise(), as the in-flight [4] makes that change.
1. ee1f0c242ef (read-cache: add index.skipHash config option,
2023-01-06)
2. 6269f8eaad0 (treewide: always have a valid "index_state.repo"
member, 2023-01-17)
3. 7211b9e7534 (repo-settings: consolidate some config settings,
2019-08-13)
4. <Y/hbUsGPVNAxTdmS@coredump.intra.peff.net>
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-03-28 21:58:58 +08:00
|
|
|
if (!repo_get_oid(r, "HEAD", &head_oid)) {
|
2022-01-26 21:05:38 +08:00
|
|
|
head = &head_oid;
|
|
|
|
} else if (!oid || !reset_hard) {
|
2020-04-07 22:28:00 +08:00
|
|
|
ret = error(_("could not determine HEAD revision"));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!oid)
|
|
|
|
oid = &head_oid;
|
|
|
|
|
|
|
|
if (refs_only)
|
2022-01-26 21:05:46 +08:00
|
|
|
return update_refs(opts, oid, head);
|
2020-04-07 22:28:00 +08:00
|
|
|
|
2022-01-26 21:05:41 +08:00
|
|
|
action = reset_hard ? "reset" : "checkout";
|
2020-04-07 22:28:00 +08:00
|
|
|
setup_unpack_trees_porcelain(&unpack_tree_opts, action);
|
|
|
|
unpack_tree_opts.head_idx = 1;
|
|
|
|
unpack_tree_opts.src_index = r->index;
|
|
|
|
unpack_tree_opts.dst_index = r->index;
|
|
|
|
unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
|
|
|
|
unpack_tree_opts.update = 1;
|
|
|
|
unpack_tree_opts.merge = 1;
|
2021-09-28 00:33:43 +08:00
|
|
|
unpack_tree_opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
|
2022-11-11 03:06:05 +08:00
|
|
|
unpack_tree_opts.skip_cache_tree_update = 1;
|
2020-04-30 07:15:27 +08:00
|
|
|
init_checkout_metadata(&unpack_tree_opts.meta, switch_to_branch, oid, NULL);
|
2022-01-26 21:05:39 +08:00
|
|
|
if (reset_hard)
|
2021-09-28 00:33:44 +08:00
|
|
|
unpack_tree_opts.reset = UNPACK_RESET_PROTECT_UNTRACKED;
|
2020-04-07 22:28:00 +08:00
|
|
|
|
|
|
|
if (repo_read_index_unmerged(r) < 0) {
|
|
|
|
ret = error(_("could not read index"));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!reset_hard && !fill_tree_descriptor(r, &desc[nr++], &head_oid)) {
|
|
|
|
ret = error(_("failed to find tree of %s"),
|
|
|
|
oid_to_hex(&head_oid));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!fill_tree_descriptor(r, &desc[nr++], oid)) {
|
|
|
|
ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (unpack_trees(nr, desc, &unpack_tree_opts)) {
|
|
|
|
ret = -1;
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
|
|
|
tree = parse_tree_indirect(oid);
|
2024-02-23 16:34:23 +08:00
|
|
|
if (!tree) {
|
|
|
|
ret = error(_("unable to read tree (%s)"), oid_to_hex(oid));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
2020-04-07 22:28:00 +08:00
|
|
|
prime_cache_tree(r, r->index, tree);
|
|
|
|
|
|
|
|
if (write_locked_index(r->index, &lock, COMMIT_LOCK) < 0) {
|
|
|
|
ret = error(_("could not write index"));
|
|
|
|
goto leave_reset_head;
|
|
|
|
}
|
|
|
|
|
2022-01-26 21:05:43 +08:00
|
|
|
if (oid != &head_oid || update_orig_head || switch_to_branch)
|
2022-01-26 21:05:46 +08:00
|
|
|
ret = update_refs(opts, oid, head);
|
2020-04-07 22:28:00 +08:00
|
|
|
|
|
|
|
leave_reset_head:
|
|
|
|
rollback_lock_file(&lock);
|
2021-07-25 21:08:30 +08:00
|
|
|
clear_unpack_trees_porcelain(&unpack_tree_opts);
|
2020-04-07 22:28:00 +08:00
|
|
|
while (nr)
|
|
|
|
free((void *)desc[--nr].buffer);
|
|
|
|
return ret;
|
|
|
|
|
|
|
|
}
|