git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Count of San Francisco <countofsanfrancisco@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Atharva Raykar" <raykar.ath@gmail.com>
Cc: git <git@vger.kernel.org>
Subject: Re: git diff word diff bug??
Date: Thu, 29 Apr 2021 21:12:00 -0700	[thread overview]
Message-ID: <5f62472c-aa49-a587-131b-67b359978a3a@gmail.com> (raw)
In-Reply-To: <87o8e14b6a.fsf@evledraar.gmail.com>

Hi,

It would be nice to get the ability I was expecting as a new feature or 
as the default behavior. If I get to have a preference, I would prefer 
this be the new default behavior. Even as Atharva explained, when the 
addition is encountered you know it is the termination but this is 
really confusing and can lead to too many corner cases for a script to 
handle. It's just not a very natural understanding. For example, take 
the content of file1.txt and simply delete "river." (with the period).

You will now have this word diff:

The fox jumped over the
   [-wall.-]
[-Blah1e32-]
[-q432423-]
[-qe23234-]
[- 233-]
[-253-]
[-345235-]

[-53243-]
[-afsfffas-]{+He made it over.+}

The script would be confused and think that the "wall" from "[-wall-]" 
occurred on a new line in the original text (i.e. file0.txt). Forget 
about the script for a moment, a human reader would be confused by 
looking at a diff and if they were in a code review process, they may be 
confused by which line the original "wall" belonged to.

Also, adding an additional new line as suggested by Ævar sometimes work 
and sometimes does not as I experiment that idea with other diffs. I 
found that if you add an additional "fake" and non-empty new line, the 
word-diff gets what I wanted. For example, if I add "xxx fake new line" 
for every new line, the word diff produces something more intuitive and 
"natural" to understand what really changed.

So, can we get this new behavior added/supported?

Thanks,

Scott


On 4/26/21 2:45 AM, Ævar Arnfjörð Bjarmason wrote:
> On Sun, Apr 25 2021, Atharva Raykar wrote:
>
>> On 20-Apr-2021, at 22:08, Count of San Francisco<countofsanfrancisco@gmail.com>  wrote:
>>> Hi All,
>>>
>>> Here is my "git bugreport":
>>>
>>> Thank you for filling out a Git bug report!
>>> Please answer the following questions to help us understand your issue.
>>>
>>> What did you do before the bug happened? (Steps to reproduce your issue)
>>>    git diff --word-diff=porcelain file0.txt file1.txt
>>>      or
>>>    git diff --word-diff file0.txt file1.txt
>>>
>>> What did you expect to happen? (Expected behavior)
>>>
>>>    I expected the diff for porcelain or default word-diff to be clear on which lines got removed and which changes belong to which line. I explain more in details below.
>>>
>>> What happened instead? (Actual behavior)
>>>
>>>    The diff was not clear.
>>>
>>> What's different between what you expected and what actually happened?
>>>
>>>    The diff made it looked like all the removed text were on one line and a later change in a line look like it was meant for a different line. When in fact, the later changes were for the same line (i.e. the first line). More details below.
>>>
>>> Anything else you want to add:
>>>
>>> Here are the details to reproduce and more details on how I interpreted the diff. If I am writing a script to highlight changes or to do extra processing for my specific use case, my script would get confused as to what really changed.
>>>
>>> file0.txt content:
>>> *** Begin Content *** --> this line is not in the actual file but just a marker here for clarity.
>>> The fox jumped over the wall.
>>> Blah1e32
>>> q432423
>>> qe23234
>>>   233
>>> 253
>>> 345235
>>>
>>> 53243
>>> afsfffas
>>> *** End Content ****
>>>
>>> file1.txt content:
>>> *** Begin Content ***
>>> The fox jumped over the river.
>>>    He made it over.
>>> *** End Content ****
>>>
>>> git diff --word-diff file0.txt file1.txt produced this:
>>> diff --git a/file0.txt b/file1.txt
>>> index c8756ba..3413f10 100644
>>> --- a/file0.txt
>>> +++ b/file1.txt
>>> @@ -1,11 +1,2 @@
>>> The fox jumped over the [-wall.-]
>>> [-Blah1e32-]
>>> [-q432423-]
>>> [-qe23234-]
>>> [- 233-]
>>> [-253-]
>>> [-345235-]
>>>
>>> [-53243-]
>>> [-afsfffas-]{+river.+}
>>> {+  He made it over.+}
>> >From my experience, git diff prefers to bundle up a series of
>> deletions or additions into a group if they all have the same
>> word delimiter. The way I would interpret this diff is the steps
>> needed to be taken when moving left to right in file0 to get to
>> the state of file1, while minimising the number of times file1
>> has to be consulted to know what needs to be done next.
>>
>> Here it would be:
>> "Delete all the words from 'wall' upto 'afsfffas', and then add
>> 'river.' and ' He made it over'".
>>
>>> The diff above does not make it clear that the "{+river+}" is really to be appended (or related) to the first line.
>>> I expected the first diff line to look like this:
>>> The fox jumped over the [-wall.-]{+river+} and the rest of the lines are delete lines.
>>>
>>> git diff --word-diff=porcelain file0.txt file1.txt produced this:
>>> diff --git a/file0.txt b/file1.txt
>>> index c8756ba..3413f10 100644
>>> --- a/file0.txt
>>> +++ b/file1.txt
>>> @@ -1,11 +1,2 @@
>>>   The fox jumped over the
>>> -wall.
>>> ~
>>> -Blah1e32
>>> ~
>>> -q432423
>>> ~
>>> -qe23234
>>> ~
>>> - 233
>>> ~
>>> -253
>>> ~
>>> -345235
>>> ~
>>> ~
>>> -53243
>>> ~
>>> -afsfffas
>>> +river.
>>> ~
>>> +  He made it over.
>>> ~
>>>
>>> This is more non-discernable. The git diff --help documentation says
>>> that "Newlines in the input are represented by a tilde ~ on a line
>>> of its own". So a script would see the '~' character and interpret
>>> that as a new line. The script would have mistaken the "+river" for
>>> a different line. The git diff --help documentation does not explain
>>> what to do in this scenario.
>>>
>>> I expected this:
>>>   The fox jumped over the
>>> -wall.
>>> +river.
>>> ~
>> This is also consistent with the behaviour I mentioned above.
>> A script would need to interpret this as:
>> delete "wall"        (this starts the streak of deletions)
>> go to next line
>> delete "Blah1e32"
>> ...
>>
>> and as soon as it sees a '+', that is, an addition, it knows
>> the series of deletions are done with, so it will add "river"
>> to the last line that was common to both, that is,
>> "the fox jumped over the".
>>
>>> Is this a bug? If not, how do I make the distinction that the {+river+} (in the first case) and the +river (in the 2nd case) is really for the first line?
>> I do not think this is a bug, because it does not really
>> deviate from any specified behaviour. But I do see the source
>> of confusion.
>>
>> I hope I could explain that well enough.
> I do think it's somewhere between a "bug" and a "missing feature"
> though.
>
> The core issue here is that in diff.c we "fake up" the whole word-diff
> mode by essentially taking both sides, splitting them on whitespace, and
> then diffing that. So for A/B like:
>
>      A: foo bar
>         baz
>      B: foo baz
>         boo
>
> We diff:
>
>      A: foo\nbar\nbaz
>      B: foo\nbaz\nboo
>
> If you insert an extra newline into that stream you'll get different
> results, which is closer to what the Count is expecting here.
>
> In this case using --word-diff-regex='[^\n]' will produce:
>
>      The fox jumped over the [-wall-]{+river+}.
>
> But the rest of the output isn't ideal, exercise for the user and all
> that.
>
> The bug is arguably that we should be doing this by default, i.e. we
> split up our output into "\n" internally, and arguably confuse that with
> what the user wanted from their input.
>
> But see bf82940dbf1 (color-words: enable REG_NEWLINE to help user,
> 2009-01-17) which is probably the source of the "bug" here (if any) for
> a trade-off related to that.
>

  reply	other threads:[~2021-04-30  4:12 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-20 16:38 Count of San Francisco
2021-04-25  8:54 ` Atharva Raykar
2021-04-26  9:45   ` Ævar Arnfjörð Bjarmason
2021-04-30  4:12     ` Count of San Francisco [this message]
2021-05-02 18:00     ` Phillip Wood
2021-05-03  9:47       ` Phillip Wood
2022-06-07 22:40         ` Scott Phuong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5f62472c-aa49-a587-131b-67b359978a3a@gmail.com \
    --to=countofsanfrancisco@gmail.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=raykar.ath@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).