git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Stefan Beller <sbeller@google.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "git@vger.kernel.org" <git@vger.kernel.org>,
	Brandon Williams <bmwill@google.com>,
	Jonathan Nieder <jrnieder@gmail.com>,
	Jonathan Tan <jonathantanmy@google.com>,
	Jeff King <peff@peff.net>,
	Michael Haggerty <mhagger@alum.mit.edu>
Subject: Re: [PATCHv5 00/17] Diff machine: highlight moved lines.
Date: Thu, 25 May 2017 09:31:27 -0700	[thread overview]
Message-ID: <CAGZ79kYO8DoTDCXCk1uSFSAJA5JusD-t4BZoQfGy5n9DF34EvA@mail.gmail.com> (raw)
In-Reply-To: <xmqq7f15e8pu.fsf@gitster.mtv.corp.google.com>

On Wed, May 24, 2017 at 11:44 PM, Junio C Hamano <gitster@pobox.com> wrote:
> I was trying to see how this is useful in code moving change, with
> this command line:
>
> $ git -c color.moved diff js/blame-lib~6 js/blame-lib blame.c blame.h builtin/blame.c
>
> Some random observations:
>
>  * You do not seem to have any command line option yet.  I guess
>    that is OK while the series is still in RFC state, but when we
>    are ready to seriously start considering this for 'next', we'd
>    need something like --color-moved that can be used across "diff",
>    "log -p" and "show".

There is "--color-moved" as a command line option. (See diff.c:4290)
Oh, it is not documented! That will be fixed.

>  * As configuration variable names go, "color.moved" is probably in
>    a wrong section.  Perhaps "diff.colorMoved" or something?

As you turn on/off normal coloring via "color.diff" and this only extends
the coloring scheme, I have the impression "color" is the right section.
Maybe color.diffStyle=[normal/enhanced] and "enhanced" means this
feature for now?

The only option in the "diff" section related to color is diff.wsErrorHighlight
which has a very similar purpose, so "diff.colorMoved" would fit in that
scheme.

>
>  * The fact that I am using
>
>      [diff "color"]
>         old = red reverse
>         whitespace = blue reverse
>
>    on a "black ink on white paper" terminal might have an effect on
>    this,

Yes very much!

>    but lines printed in either bold green and on green
>    background (i.e. not new ones but are the ones moved from
>    elsewhere) stood out a lot more prominently than lines printed in
>    green (i.e. truly new additions), and I felt that this is totally
>    backwards from what I needed for this exercise.  That is, while
>    reviewing a code moving change, I want to be able to concentrate
>    primarily of three things:
>
>    - What are the new lines that are *not* moved from elsewhere?
>      Did the submitter try to sneak in unrelated changes?
>
>    - What are the changes that are truly lost, not moved to
>      elsewhere?
>
>    - Do the lines moved from elsewhere form a coherent whole?  Where
>      is the boundary between blocks of text that are copied?  Do
>      adjacent two blocks of moved text come from the same old place
>      next to each other?

So with these questions, I wonder if we want to color moved lines
as "color.diff.context" (i.e. plain white text in the normal coloring scheme)
This would serve the intended purpose of
dimming the attention to moved lines.

Regarding the last point of marking up adjacent blocks (which would
indicate that there is a coherency issue or just moving from different
places), we could highlight the last line of the previous block
and first line of the next block in their "normal" colors (i.e.
color.diff.old and color.diff.new).

The very first version had some boundary coloring, but then
I switched to alternating block coloring based on an idea
by Jonathan Tan.

Maybe it is time to go back to boundary coloring, but optional
and apply the boundary color only if two blocks are adjacent?

Example of how it could look:
---8<---
    diff --git a/poetry.txt b/poetry.txt
    index 9d32b3b..cc50ca1 100644
    --- a/poetry.txt
    +++ b/poetry.txt
    @@ -1,12 +1,4 @@
[W] -A simple text is
[W] -written in paragraphs and
[W] -many more lines.
[R] -
[W]  A diff is smaller
[W]  than the pre or post image text form
[W]  used for review
[W]
[W] -In between focus
[W] -is hard to keep consistently
[W] -errors may occur
[W] -
    diff --git a/engineer.txt b/engineer.txt
    new file mode 100644
    index 0000000..8fbc0ce
    --- /dev/null
    +++ b/engineer.txt
    @@ -0,0 +1,7 @@
[W] +A simple text is
[W] +written in paragraphs and
[B] +many more lines.
[B] +In between focus
[W] +is hard to keep consistently
[W] +errors may occur
[W] +
---8<---

W -> simple White text (diff.color.context)
R -> Red text (diff.color.old)
B -> Boundary marker (Maybe just diff.color.{old/new}
      or a new color to configure)

>
>    Using colors that stand out more prominently than for the regular
>    new/old lines is counter-productive for all of these, especially
>    for the first two purposes.  I may suggest using cyan (or any
>    color that is very close to the background) so that the presense
>    of moved lines are merely felt without being distracting.  IOW,
>    while reviewing code moving patch, moved parts want to be dimmed,
>    not highlighted.

I agree. So I could resend the algorithm used with other defaults
or try out the "boundary only iff adjacent blocks, else context color".

Thanks,
Stefan

  reply	other threads:[~2017-05-25 16:31 UTC|newest]

Thread overview: 125+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20170523024048.16879-1-sbeller@google.com/>
2017-05-24 21:40 ` [PATCHv5 00/17] Diff machine: highlight moved lines Stefan Beller
2017-05-24 21:40   ` [PATCHv5 01/17] diff: readability fix Stefan Beller
2017-05-24 21:40   ` [PATCHv5 02/17] diff: move line ending check into emit_hunk_header Stefan Beller
2017-05-24 21:40   ` [PATCHv5 03/17] diff.c: factor out diff_flush_patch_all_file_pairs Stefan Beller
2017-05-24 21:40   ` [PATCHv5 04/17] diff: introduce more flexible emit function Stefan Beller
2017-06-13 21:54     ` Jonathan Tan
2017-06-13 23:41       ` Stefan Beller
2017-06-13 23:46         ` Jonathan Tan
2017-05-24 21:40   ` [PATCHv5 05/17] diff.c: convert fn_out_consume to use emit_line Stefan Beller
2017-05-24 21:40   ` [PATCHv5 06/17] diff.c: convert builtin_diff to use emit_line_* Stefan Beller
2017-05-24 21:40   ` [PATCHv5 07/17] diff.c: convert emit_rewrite_diff " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 08/17] diff.c: convert emit_rewrite_lines " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 09/17] submodule.c: convert show_submodule_summary to use emit_line_fmt Stefan Beller
2017-05-24 21:40   ` [PATCHv5 10/17] diff.c: convert emit_binary_diff_body to use emit_line_* Stefan Beller
2017-05-24 21:40   ` [PATCHv5 11/17] diff.c: convert show_stats " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 12/17] diff.c: convert word diffing " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 13/17] diff.c: convert diff_flush " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 14/17] diff.c: convert diff_summary " Stefan Beller
2017-05-24 21:40   ` [PATCHv5 15/17] diff.c: emit_line includes whitespace highlighting Stefan Beller
2017-05-24 21:40   ` [PATCHv5 16/17] diff: buffer all output if asked to Stefan Beller
2017-05-25  2:26     ` Junio C Hamano
2017-05-25  5:34       ` Stefan Beller
2017-05-26  1:09         ` Junio C Hamano
2017-06-13 22:07     ` Jonathan Tan
2017-06-14  2:52       ` Stefan Beller
2017-05-24 21:40   ` [PATCHv5 17/17] diff.c: color moved lines differently Stefan Beller
2017-05-25  2:27     ` Junio C Hamano
2017-05-25  5:39       ` Stefan Beller
2017-05-25  6:44   ` [PATCHv5 00/17] Diff machine: highlight moved lines Junio C Hamano
2017-05-25 16:31     ` Stefan Beller [this message]
2017-05-26  1:20       ` Junio C Hamano
2017-05-26 19:30         ` Stefan Beller
2017-05-27  0:18           ` [PATCH 0/1] " Stefan Beller
2017-05-27  0:18             ` [PATCH 1/1] diff.c: color moved lines differently Stefan Beller
2017-05-27  7:05               ` Philip Oakley
2017-05-30 21:33                 ` Stefan Beller
2017-06-01  0:24                   ` [PATCH] " Stefan Beller
2017-06-13 22:51                     ` Jonathan Tan
2017-06-14 18:55                       ` Stefan Beller
2017-06-20  2:47                         ` [PATCH 00/26] reroll of sb/diff-color-moved Stefan Beller
2017-06-20  2:47                           ` [PATCH 01/26] diff.c: readability fix Stefan Beller
2017-06-20  2:47                           ` [PATCH 02/26] diff.c: move line ending check into emit_hunk_header Stefan Beller
2017-06-20  2:47                           ` [PATCH 03/26] diff.c: factor out diff_flush_patch_all_file_pairs Stefan Beller
2017-06-20  2:47                           ` [PATCH 04/26] diff.c: introduce emit_diff_symbol Stefan Beller
2017-06-21 19:36                             ` Junio C Hamano
2017-06-21 19:46                               ` Stefan Beller
2017-06-21 20:26                                 ` Junio C Hamano
2017-06-21 21:13                                 ` Junio C Hamano
2017-06-21 21:23                                   ` Stefan Beller
2017-06-21 21:43                                     ` Junio C Hamano
2017-06-21 21:51                                       ` Stefan Beller
2017-06-21 21:45                                 ` Brandon Williams
2017-06-21 21:52                                   ` Junio C Hamano
2017-06-21 21:55                                     ` Brandon Williams
2017-06-20  2:47                           ` [PATCH 05/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_MARKER Stefan Beller
2017-06-20  2:47                           ` [PATCH 06/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_FRAGINFO Stefan Beller
2017-06-20  2:47                           ` [PATCH 07/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_NO_LF_EOF Stefan Beller
2017-06-20  2:47                           ` [PATCH 08/26] diff.c: migrate emit_line_checked to use emit_diff_symbol Stefan Beller
2017-06-21 20:05                             ` Junio C Hamano
2017-06-22 23:30                               ` Stefan Beller
2017-06-22 23:37                                 ` Stefan Beller
2017-06-23  4:56                                   ` Junio C Hamano
2017-06-20  2:47                           ` [PATCH 09/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_WORDS{_PORCELAIN} Stefan Beller
2017-06-20  2:48                           ` [PATCH 10/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_INCOMPLETE Stefan Beller
2017-06-20  2:48                           ` [PATCH 11/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_FILEPAIR Stefan Beller
2017-06-20 20:01                             ` Jonathan Tan
2017-06-21 20:09                               ` Junio C Hamano
2017-06-22 23:59                                 ` Stefan Beller
2017-06-20  2:48                           ` [PATCH 12/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_HEADER Stefan Beller
2017-06-20  2:48                           ` [PATCH 13/26] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_BINARY_FILES Stefan Beller
2017-06-21 20:13                             ` Junio C Hamano
2017-06-21 20:47                               ` Stefan Beller
2017-06-20  2:48                           ` [PATCH 14/26] diff.c: emit_diff_symbol learns DIFF_SYMBOL_REWRITE_DIFF Stefan Beller
2017-06-20  2:48                           ` [PATCH 15/26] submodule.c: migrate diff output to use emit_diff_symbol Stefan Beller
2017-06-20 20:09                             ` Jonathan Tan
2017-06-20  2:48                           ` [PATCH 16/26] diff.c: convert emit_binary_diff_body " Stefan Beller
2017-06-21 20:16                             ` Junio C Hamano
2017-06-20  2:48                           ` [PATCH 17/26] diff.c: convert show_stats " Stefan Beller
2017-06-21 21:39                             ` Brandon Williams
2017-06-21 22:16                               ` Stefan Beller
2017-06-20  2:48                           ` [PATCH 18/26] diff.c: convert word diffing " Stefan Beller
2017-06-20  2:48                           ` [PATCH 19/26] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_STAT_SEP Stefan Beller
2017-06-20  2:48                           ` [PATCH 20/26] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_SUMMARY Stefan Beller
2017-06-20  2:48                           ` [PATCH 21/26] diff.c: buffer all output if asked to Stefan Beller
2017-06-20  2:48                           ` [PATCH 22/26] diff.c: color moved lines differently Stefan Beller
2017-06-20 20:13                             ` Jonathan Tan
2017-06-20 20:57                               ` Stefan Beller
2017-06-20  2:48                           ` [PATCH 23/26] diff.c: color moved lines differently, plain mode Stefan Beller
2017-06-20  2:48                           ` [PATCH 24/26] diff.c: add dimming to moved line detection Stefan Beller
2017-06-21 20:23                             ` Junio C Hamano
2017-06-20  2:48                           ` [PATCH 25/26] diff: document the new --color-moved setting Stefan Beller
2017-06-20  2:48                           ` [showing-off RFC/PATCH 26/26] diff.c: have a "machine parseable" move coloring Stefan Beller
2017-06-20  2:50                             ` Stefan Beller
2017-06-23 21:43                               ` Ævar Arnfjörð Bjarmason
2017-06-21 21:51                             ` Brandon Williams
2017-06-21 21:55                               ` Junio C Hamano
2017-06-21 22:40                                 ` Stefan Beller
2017-06-23  1:28                           ` [PATCHv2 00/25] reroll of sb/diff-color-moved Stefan Beller
2017-06-23  1:28                             ` [PATCHv2 01/25] diff.c: readability fix Stefan Beller
2017-06-23  1:28                             ` [PATCHv2 02/25] diff.c: move line ending check into emit_hunk_header Stefan Beller
2017-06-23  1:28                             ` [PATCHv2 03/25] diff.c: factor out diff_flush_patch_all_file_pairs Stefan Beller
2017-06-23  1:28                             ` [PATCHv2 04/25] diff.c: introduce emit_diff_symbol Stefan Beller
2017-06-23 20:07                               ` Junio C Hamano
2017-06-23 20:13                                 ` Stefan Beller
2017-06-23  1:28                             ` [PATCHv2 05/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_MARKER Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 06/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_FRAGINFO Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 07/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_NO_LF_EOF Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 08/25] diff.c: migrate emit_line_checked to use emit_diff_symbol Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 09/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_WORDS[_PORCELAIN] Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 10/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_CONTEXT_INCOMPLETE Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 11/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_FILEPAIR_{PLUS, MINUS} Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 12/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_HEADER Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 13/25] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_BINARY_FILES Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 14/25] diff.c: emit_diff_symbol learns DIFF_SYMBOL_REWRITE_DIFF Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 15/25] submodule.c: migrate diff output to use emit_diff_symbol Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 16/25] diff.c: convert emit_binary_diff_body " Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 17/25] diff.c: convert show_stats " Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 18/25] diff.c: convert word diffing " Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 19/25] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_STAT_SEP Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 20/25] diff.c: emit_diff_symbol learns about DIFF_SYMBOL_SUMMARY Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 21/25] diff.c: buffer all output if asked to Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 22/25] diff.c: color moved lines differently Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 23/25] diff.c: color moved lines differently, plain mode Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 24/25] diff.c: add dimming to moved line detection Stefan Beller
2017-06-23  1:29                             ` [PATCHv2 25/25] diff: document the new --color-moved setting Stefan Beller

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=CAGZ79kYO8DoTDCXCk1uSFSAJA5JusD-t4BZoQfGy5n9DF34EvA@mail.gmail.com \
    --to=sbeller@google.com \
    --cc=bmwill@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jonathantanmy@google.com \
    --cc=jrnieder@gmail.com \
    --cc=mhagger@alum.mit.edu \
    --cc=peff@peff.net \
    /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).