| Message ID | 20250330204339.191382-1-karthik.188@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [v4] blame: print unblamable and ignored commits in porcelain mode | expand |
On Sun, Mar 30, 2025 at 10:43:39PM +0200, Karthik Nayak wrote: > diff --git a/t/t8013-blame-ignore-revs.sh b/t/t8013-blame-ignore-revs.sh > index 370b768149..50a0a7ca4a 100755 > --- a/t/t8013-blame-ignore-revs.sh > +++ b/t/t8013-blame-ignore-revs.sh > @@ -158,6 +158,21 @@ test_expect_success mark_unblamable_lines ' > test_cmp expect actual > ' > > +for opt in --porcelain --line-porcelain > +do > + test_expect_success "mark_unblamable_lines with $opt" ' > + sha=$(git rev-parse Y) && > + > + git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && > + sed -e "s/^\ty3/unblamable\n&/" raw >expect && > + cp expect raw && > + sed -e "s/^\ty4/unblamable\n&/" raw >expect && The intent here is to do two replacements in "raw", right? You can do this with a single call to sed(1) by chaining "-e": git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && sed -e "s/^\ty3/unblamable\n&/" \ -e "s/^\ty4/unblamable\n&/" raw >expect && Patrick
Patrick Steinhardt <ps@pks.im> writes: > On Sun, Mar 30, 2025 at 10:43:39PM +0200, Karthik Nayak wrote: >> diff --git a/t/t8013-blame-ignore-revs.sh b/t/t8013-blame-ignore-revs.sh >> index 370b768149..50a0a7ca4a 100755 >> --- a/t/t8013-blame-ignore-revs.sh >> +++ b/t/t8013-blame-ignore-revs.sh >> @@ -158,6 +158,21 @@ test_expect_success mark_unblamable_lines ' >> test_cmp expect actual >> ' >> >> +for opt in --porcelain --line-porcelain >> +do >> + test_expect_success "mark_unblamable_lines with $opt" ' >> + sha=$(git rev-parse Y) && >> + >> + git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && >> + sed -e "s/^\ty3/unblamable\n&/" raw >expect && >> + cp expect raw && >> + sed -e "s/^\ty4/unblamable\n&/" raw >expect && > > The intent here is to do two replacements in "raw", right? You can do > this with a single call to sed(1) by chaining "-e": > > git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && > sed -e "s/^\ty3/unblamable\n&/" \ > -e "s/^\ty4/unblamable\n&/" raw >expect && > > Patrick Nice, I first tried to use `-i`, but seems like that doesn't work with the 'sed' shipped in OSX. Didn't know I could chain it. This makes it cleaner.
Hi Karthik On 30/03/2025 21:43, Karthik Nayak wrote: > > +for opt in --porcelain --line-porcelain > +do > + test_expect_success "mark_unblamable_lines with $opt" ' > + sha=$(git rev-parse Y) && > + > + git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && > + sed -e "s/^\ty3/unblamable\n&/" raw >expect && > + cp expect raw && > + sed -e "s/^\ty4/unblamable\n&/" raw >expect && Thanks for improving the test. Unfortunately using '\n' in the replacement text is not portable [1] (the normal backslash escapes are allowed in the pattern though so the '\t' is fine). One has to write a literal newline escaped with a backslash. However here we want to insert a whole new line of text into the output without changing the original so I would write it as sed -e "/^\ty3/a\\" -e unblamable -e "/^\ty4/a\\" -e unblamable \ raw >expect Best Wishes Phillip [1] <https://pubs.opengroup.org/onlinepubs/9799919799/> The relevant section of the text reads A line can be split by substituting a <newline> into it. The application shall escape the <newline> in the replacement by preceding it by a <backslash>. The meaning of an unescaped <backslash> immediately followed by any character other than '&', <backslash>, a digit, <newline>, or the delimiter character used for this command, is unspecified. > + > + git -c blame.markUnblamableLines=true blame $opt --ignore-rev Y file >actual && > + test_cmp expect actual > + ' > +done > + > # Commit Z will touch the first two lines. Y touched all four. > # A--B--X--Y--Z > # The blame output when ignoring Z should be: > @@ -191,6 +206,21 @@ test_expect_success mark_ignored_lines ' > ! test_cmp expect actual > ' > > +for opt in --porcelain --line-porcelain > +do > + test_expect_success "mark_ignored_lines with $opt" ' > + sha=$(git rev-parse Y) && > + > + git -c blame.markIgnoredLines=false blame $opt --ignore-rev Z file >raw && > + sed -e "s/^\tline-one-Z/ignored\n&/" raw >expect && > + cp expect raw && > + sed -e "s/^\tline-two-Z/ignored\n&/" raw >expect && > + > + git -c blame.markIgnoredLines=true blame $opt --ignore-rev Z file >actual && > + test_cmp expect actual > + ' > +done > + > # For ignored revs that added 'unblamable' lines and more recent commits changed > # the blamable lines, mark the unblamable lines with a > # '*'
On 31/03/2025 11:24, phillip.wood123@gmail.com wrote: > > (the normal backslash escapes are > allowed in the pattern though so the '\t' is fine). Sorry that's wrong, you need to use a literal tab character instead of '\t' Best Wishes Phillip
[Restoring cc to the mailing list that I accidentally dropped in my previous message] On 01/04/2025 17:57, Karthik Nayak wrote: > Phillip Wood <phillip.wood123@gmail.com> writes: >> On 31/03/2025 16:25, Karthik Nayak wrote: >>> phillip.wood123@gmail.com writes: >>>> On 30/03/2025 21:43, Karthik Nayak wrote: >>>>> >>>>> +for opt in --porcelain --line-porcelain >>>>> +do >>>>> + test_expect_success "mark_unblamable_lines with $opt" ' >>>>> + sha=$(git rev-parse Y) && >>>>> + >>>>> + git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && >>>>> + sed -e "s/^\ty3/unblamable\n&/" raw >expect && >>>>> + cp expect raw && >>>>> + sed -e "s/^\ty4/unblamable\n&/" raw >expect && >>>> >>>> Thanks for improving the test. Unfortunately using '\n' in the >>>> replacement text is not portable [1] (the normal backslash escapes are >>>> allowed in the pattern though so the '\t' is fine). One has to write a >>>> literal newline escaped with a backslash. However here we want to insert >>>> a whole new line of text into the output without changing the original >>>> so I would write it as >>> >>> Thanks for bringing this to my notice. I didn't know. >>> >>>> sed -e "/^\ty3/a\\" -e unblamable -e "/^\ty4/a\\" -e unblamable \ >>>> raw >expect >>> >>> This appends 'unblamable' to the next line, but we want to prepend it. >> >> Sorry, I misread the original. If you use 'i' instead of 'a' that will >> insert a new line before the current one. > > Seems like this won't work either, since MacOS complains [1] about it: > > expecting success of 8013.16 'mark_ignored_lines with --line-porcelain': > sha=$(git rev-parse Y) && > git -c blame.markIgnoredLines=false blame $opt --ignore-rev Z file >raw && > sed -e "/^ line-one-Z/i\\" -e ignored \ > -e "/^ line-two-Z/i\\" -e ignored \ > raw >expect && > git -c blame.markIgnoredLines=true blame $opt --ignore-rev Z file >actual && > test_cmp expect actual > > +++ git rev-parse Y > ++ sha=e0d35d6f2d5fab63267e58d684cea1ECG86f12b1 > ++ git -c blame.markIgnoredLines=false blame --line-porcelain > --ignore-rev Z file > ++ sed -e '/^ line-one-Z/i\' -e ignored -e '/^ line-two-Z/i\' -e ignored raw > sed: 1: "ignored > ": command i expects \ followed by text > error: last command exited with $?=1 Oh, that's a pain, I thought it was supposed to treat each '-e' as a separate line. > I did have success [2] with using a heredoc instead: > > cat > sedscript <<- 'EOF' && > /^ y3/i\\ > unblamable > /^ y4/i\\ > unblamable > EOF > sed -f sedscript raw >expect && > > What do you think about this? I think that's the best way then. We could pass a multiline string with '-e' but then we wouldn't be able to indent the "unblamable" lines. Best Wishes Phillip > [1]: https://gitlab.com/gitlab-org/git/-/jobs/9581456879 > [2]: https://gitlab.com/gitlab-org/git/-/pipelines/1746265204
diff --git a/Documentation/blame-options.adoc b/Documentation/blame-options.adoc index aa77406d4e..19ea187238 100644 --- a/Documentation/blame-options.adoc +++ b/Documentation/blame-options.adoc @@ -125,7 +125,8 @@ take effect. another commit will be marked with a `?` in the blame output. If the `blame.markUnblamableLines` config option is set, then those lines touched by an ignored commit that we could not attribute to another revision are - marked with a '*'. + marked with a '*'. In the porcelain modes, we print 'ignored' and + 'unblamable' on a newline respectively. --ignore-revs-file <file>:: Ignore revisions listed in `file`, which must be in the same format as an diff --git a/Documentation/git-blame.adoc b/Documentation/git-blame.adoc index f75ed44790..e438d28625 100644 --- a/Documentation/git-blame.adoc +++ b/Documentation/git-blame.adoc @@ -135,10 +135,11 @@ header elements later. The porcelain format generally suppresses commit information that has already been seen. For example, two lines that are blamed to the same commit will both be shown, but the details for that commit will be shown -only once. This is more efficient, but may require more state be kept by -the reader. The `--line-porcelain` option can be used to output full -commit information for each line, allowing simpler (but less efficient) -usage like: +only once. Information which is specific to individual lines will not be +grouped together, like revs to be marked 'ignored' or 'unblamable'. This +is more efficient, but may require more state be kept by the reader. The +`--line-porcelain` option can be used to output full commit information +for each line, allowing simpler (but less efficient) usage like: # count the number of lines attributed to each author git blame --line-porcelain file | diff --git a/builtin/blame.c b/builtin/blame.c index c470654c7e..9436f70aec 100644 --- a/builtin/blame.c +++ b/builtin/blame.c @@ -351,6 +351,19 @@ static void emit_porcelain_details(struct blame_origin *suspect, int repeat) write_filename_info(suspect); } +/* + * Information which needs to be printed per-line goes here. Any + * information which can be clubbed on a commit/file level, should + * be printed via 'emit_one_suspect_detail()'. + */ +static void emit_porcelain_per_line_details(struct blame_entry *ent) +{ + if (mark_unblamable_lines && ent->unblamable) + puts("unblamable"); + if (mark_ignored_lines && ent->ignored) + puts("ignored"); +} + static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent, int opt) { @@ -367,6 +380,7 @@ static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent, ent->lno + 1, ent->num_lines); emit_porcelain_details(suspect, repeat); + emit_porcelain_per_line_details(ent); cp = blame_nth_line(sb, ent->lno); for (cnt = 0; cnt < ent->num_lines; cnt++) { @@ -377,6 +391,7 @@ static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent, ent->lno + 1 + cnt); if (repeat) emit_porcelain_details(suspect, 1); + emit_porcelain_per_line_details(ent); } putchar('\t'); do { diff --git a/t/t8013-blame-ignore-revs.sh b/t/t8013-blame-ignore-revs.sh index 370b768149..50a0a7ca4a 100755 --- a/t/t8013-blame-ignore-revs.sh +++ b/t/t8013-blame-ignore-revs.sh @@ -158,6 +158,21 @@ test_expect_success mark_unblamable_lines ' test_cmp expect actual ' +for opt in --porcelain --line-porcelain +do + test_expect_success "mark_unblamable_lines with $opt" ' + sha=$(git rev-parse Y) && + + git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && + sed -e "s/^\ty3/unblamable\n&/" raw >expect && + cp expect raw && + sed -e "s/^\ty4/unblamable\n&/" raw >expect && + + git -c blame.markUnblamableLines=true blame $opt --ignore-rev Y file >actual && + test_cmp expect actual + ' +done + # Commit Z will touch the first two lines. Y touched all four. # A--B--X--Y--Z # The blame output when ignoring Z should be: @@ -191,6 +206,21 @@ test_expect_success mark_ignored_lines ' ! test_cmp expect actual ' +for opt in --porcelain --line-porcelain +do + test_expect_success "mark_ignored_lines with $opt" ' + sha=$(git rev-parse Y) && + + git -c blame.markIgnoredLines=false blame $opt --ignore-rev Z file >raw && + sed -e "s/^\tline-one-Z/ignored\n&/" raw >expect && + cp expect raw && + sed -e "s/^\tline-two-Z/ignored\n&/" raw >expect && + + git -c blame.markIgnoredLines=true blame $opt --ignore-rev Z file >actual && + test_cmp expect actual + ' +done + # For ignored revs that added 'unblamable' lines and more recent commits changed # the blamable lines, mark the unblamable lines with a # '*'
The 'git-blame(1)' command allows users to ignore specific revisions via the '--ignore-rev <rev>' and '--ignore-revs-file <file>' flags. These flags are often combined with the 'blame.markIgnoredLines' and 'blame.markUnblamableLines' config options. These config options prefix ignored and unblamable lines with a '?' and '*', respectively. However, this option was never extended to the porcelain mode of 'git-blame(1)'. Since the documentation does not indicate this exclusion, it is a bug. Fix this by printing 'ignored' and 'unblamable' respectively for the options when using the porcelain modes. Helped-by: Patrick Steinhardt <ps@pks.im> Helped-by: Toon Claes <toon@iotcl.com> Signed-off-by: Karthik Nayak <karthik.188@gmail.com> --- Changes in v4: - Remove extra newline in 'puts'. Modify the test to compare the entire output, the earlier test missed the extraneous newline. - Link to v3: https://lore.kernel.org/r/20250329-514-git-blame-1-s-porcelain-output-does-not-emit-unblamable-and-ignored-markers-v3-1-10f695ae519a@gmail.com Changes in v3: - Use double-qoutes in the test to ensure correct variable dereference. - Fix incorrect test name. - Rename the function from 'emit_per_line_details()' to 'emit_porcelain_per_line_details()' to be more descriptive. - Ues 'puts()' instead of 'printf()'. - Link to v2: https://lore.kernel.org/r/20250326-514-git-blame-1-s-porcelain-output-does-not-emit-unblamable-and-ignored-markers-v2-1-79037e17a74b@gmail.com Changes in v2: - Instead of printing the markers before the SHA in porcelain mode and breaking scripts and backward compatability, let's instead add a newline printing 'unblamable' or 'ignored'. This is printed per line in both the porcelain modes. - Link to v1: https://lore.kernel.org/r/20250321-514-git-blame-1-s-porcelain-output-does-not-emit-unblamable-and-ignored-markers-v1-1-44b562d9beb8@gmail.com --- Range-diff versus v3: 1: bc359248f6 ! 1: 5250fb436e blame: print unblamable and ignored commits in porcelain mode @@ builtin/blame.c: static void emit_porcelain_details(struct blame_origin *suspect +static void emit_porcelain_per_line_details(struct blame_entry *ent) +{ + if (mark_unblamable_lines && ent->unblamable) -+ puts("unblamable\n"); ++ puts("unblamable"); + if (mark_ignored_lines && ent->ignored) -+ puts("ignored\n"); ++ puts("ignored"); +} + static void emit_porcelain(struct blame_scoreboard *sb, struct blame_entry *ent, @@ t/t8013-blame-ignore-revs.sh: test_expect_success mark_unblamable_lines ' + test_expect_success "mark_unblamable_lines with $opt" ' + sha=$(git rev-parse Y) && + ++ git -c blame.markUnblamableLines=false blame $opt --ignore-rev Y file >raw && ++ sed -e "s/^\ty3/unblamable\n&/" raw >expect && ++ cp expect raw && ++ sed -e "s/^\ty4/unblamable\n&/" raw >expect && ++ + git -c blame.markUnblamableLines=true blame $opt --ignore-rev Y file >actual && -+ test $(grep ^unblamable actual | wc -l) -eq 2 ++ test_cmp expect actual + ' +done + @@ t/t8013-blame-ignore-revs.sh: test_expect_success mark_ignored_lines ' + test_expect_success "mark_ignored_lines with $opt" ' + sha=$(git rev-parse Y) && + ++ git -c blame.markIgnoredLines=false blame $opt --ignore-rev Z file >raw && ++ sed -e "s/^\tline-one-Z/ignored\n&/" raw >expect && ++ cp expect raw && ++ sed -e "s/^\tline-two-Z/ignored\n&/" raw >expect && ++ + git -c blame.markIgnoredLines=true blame $opt --ignore-rev Z file >actual && -+ test $(grep ^ignored actual | wc -l) -eq 2 ++ test_cmp expect actual + ' +done + --- Documentation/blame-options.adoc | 3 ++- Documentation/git-blame.adoc | 9 +++++---- builtin/blame.c | 15 +++++++++++++++ t/t8013-blame-ignore-revs.sh | 30 ++++++++++++++++++++++++++++++ 4 files changed, 52 insertions(+), 5 deletions(-)