Re: [PATCH 1/2] gitk: align the commit summary format to the documentation

Beat Bolli [off-list ref] writes:

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Make the text generated by the "Copy commit summary" command match this
format.

Hmph.  I didn't know gitk already had its own command to produce a
short string.  I actually think what it produces

In 175d38c ("SubmittingPatches: document how to reference previous commits",
2016-07-28) the format for referring to older commits was specified.

is easier to read when pasted into a sentence than what the recent
update 175d38ca ("SubmittingPatches: document how to reference
previous commits", 2016-07-28) suggests to do, i.e.

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Heiko, Stefan, I think you two were involved in adding that new
paragraph.   What do you think?

On Fri, Aug 26, 2016 at 11:24 AM, Junio C Hamano [off-list ref] wrote:

Beat Bolli [off-list ref] writes:

quoted

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Make the text generated by the "Copy commit summary" command match this
format.

Hmph.  I didn't know gitk already had its own command to produce a
short string.  I actually think what it produces

It was added in d835dbb91fe (gitk: Add a "Copy commit summary" command,
2015-07-18), it doesn't seem to be in your tree yet, so maybe wait
with this patch
until you pulled gitk?

quoted

In 175d38c ("SubmittingPatches: document how to reference previous commits",
2016-07-28) the format for referring to older commits was specified.

is easier to read when pasted into a sentence than what the recent
update 175d38ca ("SubmittingPatches: document how to reference
previous commits", 2016-07-28) suggests to do, i.e.

quoted

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Heiko, Stefan, I think you two were involved in adding that new
paragraph.   What do you think?

So the subtle difference is adding '"' around the commit message subject?

I agree we should fix that.

On 26.08.16 21:16, Stefan Beller wrote:

On Fri, Aug 26, 2016 at 11:24 AM, Junio C Hamano [off-list ref] wrote:

quoted

Beat Bolli [off-list ref] writes:

quoted

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Make the text generated by the "Copy commit summary" command match this
format.

Hmph.  I didn't know gitk already had its own command to produce a
short string.  I actually think what it produces

It was added in d835dbb91fe (gitk: Add a "Copy commit summary" command,
2015-07-18), it doesn't seem to be in your tree yet, so maybe wait
with this patch
until you pulled gitk?

This commit was part of release 2.6.0.

quoted

quoted

In 175d38c ("SubmittingPatches: document how to reference previous commits",
2016-07-28) the format for referring to older commits was specified.

is easier to read when pasted into a sentence than what the recent
update 175d38ca ("SubmittingPatches: document how to reference
previous commits", 2016-07-28) suggests to do, i.e.

quoted

In 175d38c (SubmittingPatches: document how to reference previous commits,
2016-07-28) the format for referring to older commits was specified.

Heiko, Stefan, I think you two were involved in adding that new
paragraph.   What do you think?

So the subtle difference is adding '"' around the commit message subject?

I agree we should fix that.

So would you prepare a amendment to your documentation commit so that
Junio can disregard my two patches?

Thanks,
Beat

Am 26.08.2016 um 20:24 schrieb Junio C Hamano:

Beat Bolli [off-list ref] writes:

quoted

In 175d38c ("SubmittingPatches: document how to reference previous commits",
2016-07-28) the format for referring to older commits was specified.

is easier to read when pasted into a sentence than what the recent
update 175d38ca ("SubmittingPatches: document how to reference
previous commits", 2016-07-28) suggests to do, i.e.

While it may be easier to read due to the extra mark-up, the resulting 
text where such a quotation appears does not flow well, IMO. A commit 
message text that references another commit reads more fluently without 
the quotes around the summary line because the quoted text is not so 
much a quotation that must be marked, but a parenthetical statement.

I absolutely welcome the proposed change to gitk, because I always edit 
out the double-quotes.

-- Hannes