Re: [PATCH 2/2] SubmittingPatches: hint at gitk's "Copy commit summary" command

From: Jacob Keller <jacob.keller@gmail.com>
Date: Aug 27, 2016, 03:58 UTC
Message-ID: <CA+P7+xopLOwWO22j8i7iWjGM-+vn0ScS9mLVNrB-qt3YCX_=yw@mail.gmail.com>
In-Reply-To: <xmqqk2f3gzcm.fsf@gitster.mtv.corp.google.com>

On Fri, Aug 26, 2016 at 11:27 AM, Junio C Hamano <gitster@pobox.com> wrote:

Show 23 quoted lines

> Beat Bolli <dev+git@drbeat.li> writes:
>
>> @@ -124,7 +124,8 @@ archive, summarize the relevant points of the discussion.
>>  If you want to reference a previous commit in the history of a stable
>>  branch use the format "abbreviated sha1 (subject, date)". So for example
>>  like this: "Commit f86a374 (pack-bitmap.c: fix a memleak, 2015-03-30)
>> -noticed [...]".
>> +noticed [...]". The "Copy commit summary" command of gitk generates this
>> +format.
>
> (continuing from my 1/2 review)  And if people agree that the format
> gitk already uses is better, this text should probably read more
> like:
>
>     If you want to reference a previous commit in the history of a
>     stable branch, use the format "abbreviated sha1 (subject, date)",
>     with the subject enclosed in a pair of double-quotes, like this:
>
>         Commit f86a374 ("pack-bitmap.c: fix a memleak", 2015-03-30)
>         noticed that ...
>
>     The "Copy commit summary" command of gitk can be used to obtain this
>     format.

Tangent, but I was wondering if this would make a good built-in format, but then I looked and realized that the built-in formats didn't make much sense to me... I'm not sure where the actual format gets displayed so I am wondering if we had any thoughts about adding some --pretty=summary that we could add? I know it can be implemented via a user defined format but thought it might be worth building it in since it's a pretty common use case?

Thanks, Jake