[v4,0/2] blame: documentation update

Message

Bagas Sanjaya Oct. 3, 2021, 10:53 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 v3 [1]:
  - grammatical and wording fixes (suggested by Eric and Junio)
 
Bagas Sanjaya (2):
  blame: describe default output format
  blame: document --color-* options

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

Range-diff against v3:
1:  2478909d67 ! 1:  976c17a485 blame: Describe default output format
    @@ Metadata
     Author: Bagas Sanjaya <[e-mail]>
     
      ## Commit message ##
    -    blame: Describe default output format
    +    blame: describe default output format
     
         While there is descriptions for porcelain and incremental output
         formats, the default format isn't described. Describe that format for
    @@ Documentation/git-blame.txt: include::blame-options.txt[]
     +`git blame` will output annotation for each line with:
     +
     +- abbreviated object name for the commit the line came from;
    -+- author ident (by default author name and date unless `-s` or `-e` is
    ++- author ident (by default author name and date, unless `-s` or `-e` is
     +specified); and
     +- line number
     +
2:  a6f75786ec < -:  ---------- blame: document --color-* options
-:  ---------- > 2:  517dc2cb3d blame: document --color-* options

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

base-commit: cefe983a320c03d7843ac78e73bd513a27806845