Re: [PATCH] blame: document --color-* options

[Bagas Sanjaya <bagasdotme@gmail.com>]

On 28/09/21 19.38, Dr. Matthias St. Pierre wrote:
> Thank you Bagas for adding the documentation. I think the only that disturbed Junio is the use of the word "metadata",
> which is used internally, but not in the official documentation aimed at the git user.
> 
> Starting from your patch, I added some suggestions for alternative wordings.
> 
> Regards,
> Matthias
> 
> 
> 
> commit ae2c59b7c76d9201d68aeb21b0ce57f2845732a1
> Author: Bagas Sanjaya <bagasdotme@gmail.com>
> Date:   Tue Sep 28 10:11:23 2021 +0200
> 
>      blame: document --color-* options
> 
>      Commit cdc2d5f11f1a (builtin/blame: dim uninteresting metadata lines,
>      2018-04-23) and 25d5f52901f0 (builtin/blame: highlight recently changed
>      lines, 2018-04-23) introduce --color-lines and --color-by-age options to
>      git blame, respectively. While both options are mentioned in usage help,
>      they aren't documented in git-blame(1). Document them.
> 
>      Co-authored-by: Dr. Matthias St. Pierre <m.st.pierre@ncp-e.com>
> 
> diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
> index 117f4cf806..1560f2b6df 100644
> --- a/Documentation/blame-options.txt
> +++ b/Documentation/blame-options.txt
> @@ -136,5 +136,15 @@ take effect.
>   option.  An empty file name, `""`, will clear the list of revs from
>   previously processed files.
> 
> +--color-lines::
> +Color lines differently if they belong to the same commit as the preceding line.
> +This facilitates distinguishing code blocks introduced by different commits.
> +The color defaults to cyan and be adjusted using the `color.blame.repeatedLines`
> +config option.
> +
> +--color-by-age::
> +Color lines depending on the age of the line. The `color.blame.highlightRecent`
> +config option controls what color is used for which range of age.
> +
>   -h::
>   Show help message.
> diff --git a/Documentation/config/color.txt b/Documentation/config/color.txt
> index e05d520a86..a1cf36fc89 100644
> --- a/Documentation/config/color.txt
> +++ b/Documentation/config/color.txt
> @@ -9,8 +9,8 @@ color.advice.hint::
>   Use customized color for hints.
> 
>   color.blame.highlightRecent::
> -This can be used to color the metadata of a blame line depending
> -on age of the line.
> +Used to color line annotations differently depending on the age of the commit
> +(`git blame --color-by-age`).
>   +
>   This setting should be set to a comma-separated list of color and date settings,
>   starting and ending with a color, the dates should be set from oldest to newest.
> @@ -25,10 +25,9 @@ everything older than one year blue, recent changes between one month and
>   one year old are kept white, and lines introduced within the last month are
>   colored red.
> 
> -color.blame.repeatedLines::
> -Use the customized color for the part of git-blame output that
> -is repeated meta information per line (such as commit id,
> -author name, date and timezone). Defaults to cyan.
> +color.blame.repeated
> +Use this color to colorize line annotations, if they belong to the same commit
> +as the preceding line (`git blame --color-lines`). Defaults to cyan.
> 
>   color.branch::
>   A boolean to enable/disable color in the output of
> diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
> index 3bf5d5d8b4..cfdbad030b 100644
> --- a/Documentation/git-blame.txt
> +++ b/Documentation/git-blame.txt
> @@ -11,8 +11,8 @@ SYNOPSIS
>   'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
>       [-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
>       [--ignore-rev <rev>] [--ignore-revs-file <file>]
> -    [--progress] [--abbrev=<n>] [<rev> | --contents <file> | --reverse <rev>..<rev>]
> -    [--] <file>
> +    [--color-lines] [--color-by-age] [--progress] [--abbrev=<n>]
> +    [<rev> | --contents <file> | --reverse <rev>..<rev>] [--] <file>
> 
>   DESCRIPTION
>   -----------
> 
> 

I can't apply the suggestion patch above. You sent the patch with 
S/MIME, right?

Next time, whether you post patches here, learn to use git format-patch 
and git send-email. Send patches in plain text only, *no (S/)MIME, no 
links, no compression, no attachments*.

Please resend your suggestion patch using git send-email, keeping in 
mind the guidelines above.

-- 
An old man doll... just what I always wanted! - Clara