@matheusbsbs / matheus-bagliano / commits / 6e6a529b57

fsck: avoid misleading variable name

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>

Eric Sunshine committed Jun 29, 2023 at 14:13 UTC 6e6a529b573398f0a8828551cf04dafb4f084c9a

2 files changed +4 -4

builtin/fsck.c

+2 -2

@@ -798,7 +798,7 @@ static int fsck_resolve_undo(struct index_state *istate,

798 }

799

800 static void fsck_index(struct index_state *istate, const char *index_path,

801 - int is_main_index)

801 + int is_current_worktree)

802 {

803 unsigned int i;

804

@@ -820,7 +820,7 @@ static void fsck_index(struct index_state *istate, const char *index_path,

820 obj->flags |= USED;

821 fsck_put_object_name(&fsck_walk_options, &obj->oid,

822 "%s:%s",

823 - is_main_index ? "" : index_path,

823 + is_current_worktree ? "" : index_path,

824 istate->cache[i]->name);

825 mark_object_reachable(obj);

826 }

t/t1450-fsck.sh

+2 -2

@@ -1039,9 +1039,9 @@ test_expect_success 'fsck detects problems in worktree index' '

1039 test_cmp expect actual

1040 '

1041

1042 -test_expect_success 'fsck reports problems in main index without filename' '

1042 +test_expect_success 'fsck reports problems in current worktree index without filename' '

1043 test_when_finished "rm -f .git/index && git read-tree HEAD" &&

1044 - echo "this object will be removed to break the main index" >file &&

1044 + echo "this object will be removed to break current worktree index" >file &&

1045 git add file &&

1046 blob=$(git rev-parse :file) &&

1047 remove_object $blob &&