git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>,
	Stefan Beller <stefanbeller@gmail.com>,
	Eric Sunshine <sunshine@sunshineco.com>,
	"Dr . Matthias St . Pierre" <m.st.pierre@ncp-e.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH v4 0/2] blame: documentation update
Date: Sun,  3 Oct 2021 17:53:26 +0700	[thread overview]
Message-ID: <20211003105327.215996-1-bagasdotme@gmail.com> (raw)

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 <bagasdotme@gmail.com>
     
      ## 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/20211001113725.13354-1-bagasdotme@gmail.com/T/#t

base-commit: cefe983a320c03d7843ac78e73bd513a27806845
-- 
An old man doll... just what I always wanted! - Clara


             reply	other threads:[~2021-10-03 10:54 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-03 10:53 Bagas Sanjaya [this message]
2021-10-03 10:53 ` [PATCH v4 1/2] blame: describe default output format Bagas Sanjaya
2021-10-03 10:53 ` [PATCH v4 2/2] blame: document --color-* options Bagas Sanjaya

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211003105327.215996-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=m.st.pierre@ncp-e.com \
    --cc=stefanbeller@gmail.com \
    --cc=sunshine@sunshineco.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.
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 NNTP newsgroup(s).