git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jonathan Tan <jonathantanmy@google.com>
To: Stefan Beller <sbeller@google.com>
Cc: bmwill@google.com, git@vger.kernel.org, gitster@pobox.com,
	jrnieder@gmail.com, mhagger@alum.mit.edu, peff@peff.net,
	philipoakley@iee.org
Subject: Re: [PATCH] diff.c: color moved lines differently
Date: Tue, 13 Jun 2017 15:51:58 -0700	[thread overview]
Message-ID: <20170613155158.2454d9c7@twelve2.svl.corp.google.com> (raw)
In-Reply-To: <20170601002429.3470-1-sbeller@google.com>

On Wed, 31 May 2017 17:24:29 -0700
Stefan Beller <sbeller@google.com> wrote:

> When a patch consists mostly of moving blocks of code around, it can
> be quite tedious to ensure that the blocks are moved verbatim, and not
> undesirably modified in the move. To that end, color blocks that are
> moved within the same patch differently. For example (OM, del, add,
> and NM are different colors):

[snip]

Junio asks "are we happy with these changes" [1] and my answer is, in
general, yes - this seems like a very useful feature to have, and I'm OK
with the current design.

I do feel a bit of unease at how the emitted strings are collected
without many guarantees as to their contents (e.g. whether they are full
lines or even whether they originate from the text of a file), but this
is already true for the existing code. The potential danger is that we
are now relying more on the format of these strings, but we don't plan
to do anything other than to color them, so this seems fine.

I would also prefer if there was only one coloring method, to ease
testing, but I can tolerate the current multiplicity of options.

I think there was some discussion at trying to avoid indicating that
small blocks (consisting of few non-whitespace characters) are moved,
but I think that that can be added later.

[1] https://public-inbox.org/git/CAGZ79kY2Z-fJYxczbzheu1hChLkKkdjEcDMwsP-hkN0TjUBotQ@mail.gmail.com/

> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -231,6 +231,38 @@ ifdef::git-diff[]
>  endif::git-diff[]
>  	It is the same as `--color=never`.
>  
> +--color-moved[=<mode>]::
> +	Moved lines of code are colored differently.
> +ifdef::git-diff[]
> +	It can be changed by the `diff.colorMoved` configuration setting.
> +endif::git-diff[]
> +	The <mode> defaults to 'no' if the option is not given
> +	and to 'adjacentbounds' if the option with no mode is given.
> +	The mode must be one of:
> ++
> +--
> +no::
> +	Moved lines are not highlighted.
> +nobounds::
> +	Any line that is added in one location and was removed
> +	in another location will be colored with 'color.diff.newmoved'.
> +	Similarly 'color.diff.oldmoved' will be used for removed lines

Probably best to consistently capitalize newMoved and oldMoved.

> +static unsigned get_line_hash(struct diff_line *line, unsigned ignore_ws)
> +{
> +	static struct strbuf sb = STRBUF_INIT;
> +
> +	if (ignore_ws) {
> +		strbuf_reset(&sb);
> +		get_ws_cleaned_string(line, &sb);
> +		return memhash(sb.buf, sb.len);
> +	} else {
> +		return memhash(line->line, line->len);
> +	}
> +}

Can be written without the "else".

> +test_expect_success 'move detection does not mess up colored words' '

Probably name this test "--color-moved has no effect when used with
--word-diff".

  reply	other threads:[~2017-06-13 22:52 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
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 [this message]
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=20170613155158.2454d9c7@twelve2.svl.corp.google.com \
    --to=jonathantanmy@google.com \
    --cc=bmwill@google.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jrnieder@gmail.com \
    --cc=mhagger@alum.mit.edu \
    --cc=peff@peff.net \
    --cc=philipoakley@iee.org \
    --cc=sbeller@google.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).