mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fsck: avoid misleading variable name

Browse Source 
When reporting a problem, `git fsck` emits a message such as:

    missing blob 1234abcd (:file)

However, this can be ambiguous when the problem is detected in the index
of a worktree other than the one in which `git fsck` was invoked. To
address this shortcoming, 592ec63b38 (fsck: mention file path for index
errors, 2023-02-24) enhanced the output to mention the path of the index
when the problem is detected in some other worktree:

    missing blob 1234abcd (.git/worktrees/wt/index:file)

Unfortunately, the variable in fsck_index() which controls whether the
index path should be shown is misleadingly named "is_main_index" which
can be misunderstood as referring to the main worktree (i.e. the one
housing the .git/ repository) rather than to the current worktree (i.e.
the one in which `git fsck` was invoked). Avoid such potential confusion
by choosing a name more reflective of its actual purpose.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Eric Sunshine
2023-06-29 14:13:33 -04:00
committed by Junio C Hamano
parent 8d3e7eac52
commit 6e6a529b57
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
builtin/fsck.c
View File

@ -798,7 +798,7 @@ static int fsck_resolve_undo(struct index_state *istate,
} }
static void fsck_index(struct index_state *istate, const char *index_path, static void fsck_index(struct index_state *istate, const char *index_path,
int is_main_index) int is_current_worktree)
{ {
unsigned int i; unsigned int i;
@ -820,7 +820,7 @@ static void fsck_index(struct index_state *istate, const char *index_path,
obj->flags |= USED; obj->flags |= USED;
fsck_put_object_name(&fsck_walk_options, &obj->oid, fsck_put_object_name(&fsck_walk_options, &obj->oid,
"%s:%s", "%s:%s",
is_main_index ? "" : index_path, is_current_worktree ? "" : index_path,
istate->cache[i]->name); istate->cache[i]->name);
mark_object_reachable(obj); mark_object_reachable(obj);
} }

4
t/t1450-fsck.sh
View File

@ -1039,9 +1039,9 @@ test_expect_success 'fsck detects problems in worktree index' '
test_cmp expect actual test_cmp expect actual
' '
test_expect_success 'fsck reports problems in main index without filename' ' test_expect_success 'fsck reports problems in current worktree index without filename' '
test_when_finished "rm -f .git/index && git read-tree HEAD" && test_when_finished "rm -f .git/index && git read-tree HEAD" &&
echo "this object will be removed to break the main index" >file && echo "this object will be removed to break current worktree index" >file &&
git add file && git add file &&
blob=$(git rev-parse :file) && blob=$(git rev-parse :file) &&
remove_object $blob && remove_object $blob &&