git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: git@vger.kernel.org, Stefan Beller <stefanbeller@gmail.com>,
	"Dr . Matthias St . Pierre" <m.st.pierre@ncp-e.com>
Subject: Re: [PATCH v3 1/2] blame: Describe default output format
Date: Fri, 01 Oct 2021 15:43:19 -0700	[thread overview]
Message-ID: <xmqqfstk2woo.fsf@gitster.g> (raw)
In-Reply-To: <20211001113725.13354-2-bagasdotme@gmail.com> (Bagas Sanjaya's message of "Fri, 1 Oct 2021 18:37:25 +0700")

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> While there is descriptions for porcelain and incremental output
> formats, the default format isn't described. Describe that format for
> the sake of completeness.
>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/git-blame.txt | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
>
> diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
> index 3bf5d5d8b4..683f8ab0b0 100644
> --- a/Documentation/git-blame.txt
> +++ b/Documentation/git-blame.txt
> @@ -93,6 +93,19 @@ include::blame-options.txt[]
>  	is used for a caret to mark the boundary commit.
>  
>  
> +THE DEFAULT FORMAT
> +------------------
> +
> +When neither `--porcelain` nor `--incremental` option is specified,
> +`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
> +specified); and

It probably would become easier to read with a comma before
"unless".

Other than that (and the downcasing of Describe in the title), looks
good to me.

Thanks.

> +- line number
> +
> +before the line contents.
> +
>  THE PORCELAIN FORMAT
>  --------------------

  reply	other threads:[~2021-10-01 22:43 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-01 11:37 [PATCH v3 0/2] blame: documentation update Bagas Sanjaya
2021-10-01 11:37 ` [PATCH v3 1/2] blame: Describe default output format Bagas Sanjaya
2021-10-01 22:43   ` Junio C Hamano [this message]
2021-10-01 11:37 ` [PATCH v3 2/2] blame: document --color-* options Bagas Sanjaya
2021-10-01 19:10   ` Eric Sunshine
2021-10-02  2:35     ` Bagas Sanjaya
2021-10-04 11:41       ` Junio C Hamano

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=xmqqfstk2woo.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=m.st.pierre@ncp-e.com \
    --cc=stefanbeller@gmail.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).