Eric Sunshine wrote:
> Subject: diff: --color-moved: rename "dimmed_zebra" to "dimmed-zebra"
It would be clearer to say something like
diff --color-moved: add "dimmed-zebra" synonym for "dimmed_zebra"
> The --color-moved "dimmed_zebra" mode (with an underscore) is an
> anachronism. Most options and modes are hyphenated. It is more difficult
> to type and somewhat more difficult to read than those which are
> hyphenated. Therefore, rename it to "dimmed-zebra", and nominally
> deprecate "dimmed_zebra".
Hm. Looks like dimmed_zebra was introduced in v2.15.0-rc0~16^2~2
(2017-06-30), so it has been around for a while (about a year). But I
would like to be able to simplify by getting rid of it.
https://codesearch.debian.net/search?q=dimmed_zebra doesn't find any
instances of it being used outside Git itself.
https://twitter.com/kornelski/status/982247477020508162 (found with a
web search) shows that some people may have it in configuration.
Is there anything we can do to make it possible to remove eventually?
For example, should we (eventually, after dimmed-zebra has existed
for some time) start warning when people use dimmed_zebra to encourage
them to use dimmed-zebra instead?
> Signed-off-by: Eric Sunshine <sunsh...@sunshineco.com>
> ---
> Documentation/diff-options.txt | 3 ++-
> diff.c | 4 +++-
> t/t4015-diff-whitespace.sh | 4 ++--
> 3 files changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index 41064909ee..9195bcd398 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -282,10 +282,11 @@ zebra::
> painted using either the 'color.diff.{old,new}Moved' color or
> 'color.diff.{old,new}MovedAlternative'. The change between
> the two colors indicates that a new block was detected.
> -dimmed_zebra::
> +dimmed-zebra::
> Similar to 'zebra', but additional dimming of uninteresting parts
> of moved code is performed. The bordering lines of two adjacent
> blocks are considered interesting, the rest is uninteresting.
> + `dimmed_zebra` is a deprecated synonym.
Thanks for including that note. It means that when people see
dimmed_zebra in scripts or configuration they won't have to be
mystified about why it works.
I don't have any good ideas about deprecating more aggressively, and
the patch looks good, so
Reviewed-by: Jonathan Nieder <jrnie...@gmail.com>
Thanks.
