Skip to content

Commit

Permalink
blame: introduce --override-ignore-revs to bypass ignore revisions list
Browse files Browse the repository at this point in the history
The git blame command can ignore a list of revisions specified either
through the --ignore-revs-file option or the blame.ignoreRevsFile
configuration. This feature is useful for excluding irrelevant
commits, such as formatting changes or large refactors, from blame
annotations.

However, users may encounter cases where they need to
temporarily override these configurations to inspect all commits,
even those excluded by the ignore list. Currently, there is no
simple way to bypass all ignore revisions settings in one go.

This patch introduces the --override-ignore-revs option (or -O),
which allows users to easily bypass the --ignore-revs-file
option, --ignore-rev option and the blame.ignoreRevsFile
configuration. When this option is used, git blame will completely
disregard all configured ignore revisions lists.

The motivation behind this feature is to provide users with more
flexibility when dealing with large codebases that rely on
.git-blame-ignore-revs files for shared configurations, while
still allowing them to disable the ignore list when necessary
for troubleshooting or deeper inspections.

Signed-off-by: Abhijeetsingh Meena <[email protected]>
  • Loading branch information
Ethan0456 committed Oct 11, 2024
1 parent 4ed930c commit 8d2fa3a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
8 changes: 7 additions & 1 deletion builtin/blame.c
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ static int coloring_mode;
static struct string_list ignore_revs_file_list = STRING_LIST_INIT_DUP;
static int mark_unblamable_lines;
static int mark_ignored_lines;
static int override_ignore_revs = 0;

static struct date_mode blame_date_mode = { DATE_ISO8601 };
static size_t blame_date_width;
Expand Down Expand Up @@ -901,6 +902,7 @@ int cmd_blame(int argc,
OPT_BIT('w', NULL, &xdl_opts, N_("ignore whitespace differences"), XDF_IGNORE_WHITESPACE),
OPT_STRING_LIST(0, "ignore-rev", &ignore_rev_list, N_("rev"), N_("ignore <rev> when blaming")),
OPT_STRING_LIST(0, "ignore-revs-file", &ignore_revs_file_list, N_("file"), N_("ignore revisions from <file>")),
OPT_BOOL('O', "override-ignore-revs", &override_ignore_revs, N_("override all configurations that exclude revisions")),
OPT_BIT(0, "color-lines", &output_option, N_("color redundant metadata from previous line differently"), OUTPUT_COLOR_LINE),
OPT_BIT(0, "color-by-age", &output_option, N_("color lines by age"), OUTPUT_SHOW_AGE_WITH_COLOR),
OPT_BIT(0, "minimal", &xdl_opts, N_("spend extra cycles to find better match"), XDF_NEED_MINIMAL),
Expand Down Expand Up @@ -1119,7 +1121,11 @@ int cmd_blame(int argc,
sb.reverse = reverse;
sb.repo = the_repository;
sb.path = path;
build_ignorelist(&sb, &ignore_revs_file_list, &ignore_rev_list);

if (!override_ignore_revs) {
build_ignorelist(&sb, &ignore_revs_file_list, &ignore_rev_list);
}

string_list_clear(&ignore_revs_file_list, 0);
string_list_clear(&ignore_rev_list, 0);
setup_scoreboard(&sb, &o);
Expand Down
25 changes: 25 additions & 0 deletions t/t8016-blame-override-ignore-revs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/bin/sh

test_description='default revisions to ignore when blaming'

TEST_PASSES_SANITIZE_LEAK=true
. ./test-lib.sh

test_expect_success 'blame: override-ignore-revs' '
test_commit first-commit hello.txt hello &&
echo world >>hello.txt &&
test_commit second-commit hello.txt &&
sed "1s/hello/hi/" <hello.txt > hello.txt.tmp &&
mv hello.txt.tmp hello.txt &&
test_commit third-commit hello.txt &&
git blame hello.txt >expect &&
git rev-parse HEAD >.git-blame-ignore-revs &&
git blame -O hello.txt >actual &&
test_cmp expect actual
'

test_done

0 comments on commit 8d2fa3a

Please sign in to comment.