Re: [PATCH v2 2/2] doc/SubmittingPatches: show how to get a CLI commit summary

From: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Mar 21, 2017, 18:47 UTC
Message-ID: <CACBZZX5ofE-B0AE1gDVwN=N3g-x+m=OW72BYxK8Oz7FUkBNP7Q@mail.gmail.com>
In-Reply-To: <xmqqvar2qzof.fsf@gitster.mtv.corp.google.com>

On Tue, Mar 21, 2017 at 6:58 PM, Junio C Hamano <gitster@pobox.com> wrote:

Show 26 quoted lines

> SZEDER Gábor <szeder.dev@gmail.com> writes:
>
>>>  The "Copy commit summary" command of gitk can be used to obtain this
>>> -format.
>>> +format, or this invocation of "git show":
>>>
>>> +    git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit>
>>> +
>>> +To turn that into a handy alias:
>>> +
>>> +    git config --global alias.git-commit-summary "show -s --date=short --pretty='format:%h (\"%s\", %ad)'"
>>> +
>>> +And then to get the commit summary:
>>> +
>>> +    git git-commit-summary <commit>
>>
>> - 'tformat:' is a better fit than 'format:' in this case, because it
>>   adds a trailing newline.
>
> That depends on what you use it for.  I most often use mine to
> insert the reference that flows in a sentence, not as a separate
> displayed material, e.g.
>
>     1f6b1afe ("Git 2.12.1", 2017-03-20)
>
> so for that purpose, not adding a trailing newline is a feature.

I agree with tformat. I didn't notice this because I've been screwing around with my pager settings and my configuration was implicitly adding a newline. Do you mind fixing that up Junio, or should I re-send it?

Show 7 quoted lines

>> - I find that the two subsequent 'git's in 'git git-<whatever>' look
>>   strange.  However, to make this point moot right away:
>>
>> - I don't think SubmittingPatches is the right place to show how to
>>   create and use a command alias.
>
> These two I do agree with.

I don't think it disturbs the flow of the document, and since someone going through SubmittingPatches is likely about to submit a patch, providing that one-liner is handy, not as some "here's how to add aliases" tutorial, but so you don't need to go and copy/paste it, add \'s for the "'s etc.