[0/2] blame: documentation update

Message

Bagas Sanjaya Oct. 8, 2021, 4:33 a.m. UTC

Document the default output format for git-blame(1), as well as the
--color-* options which are currently undocumented but mentioned in
usage help.

Changes since v4 [1]:
  - Remove "(see section X)" pointer (suggested by Junio)

Bagas Sanjaya (2):
  blame: describe default output format
  blame: document --color-* options

 Documentation/blame-options.txt | 11 +++++++++++
 Documentation/config/color.txt  | 33 ++++++++++++++++++---------------
 Documentation/git-blame.txt     | 17 +++++++++++++++--
 3 files changed, 44 insertions(+), 17 deletions(-)

Range-diff against v4 [1]:
1:  976c17a485 = 1:  977c3dd77d blame: describe default output format
2:  517dc2cb3d ! 2:  df39496623 blame: document --color-* options
    @@ Documentation/blame-options.txt: take effect.
      	previously processed files.
      
     +--color-lines::
    -+	Color line annotations (see "The Default Format" section) differently if they
    -+	come from the same commit as the preceding line, and if neither `--porcelain`
    -+	nor `--incremental` format option is specified. This makes it easier to distinguish
    ++	Color line annotations, in the default format, differently if they come from
    ++	the same commit as the preceding line. This makes it easier to distinguish
     +	code blocks introduced by different commits. The color defaults to cyan and
     +	can be adjusted using the `color.blame.repeatedLines` config option.
     +
     +--color-by-age::
    -+	Color line annotations (see "The Default Format" section) depending on the age of
    -+	the line, if neither `--porcelain` nor `--incremental` format option is specified.
    ++	Color line annotations depending on the age of the line, in the default format.
     +	The `color.blame.highlightRecent` config option controls what color is used for
     +	each range of age.
     +

[1]:
https://lore.kernel.org/git/[e-mail]/T/#u

base-commit: 106298f7f9cca4158a980de149ef217751e1f943