Re: [PATCH 2/2] SubmittingPatches: hint at gitk's "Copy commit summary" command
On Fri, Aug 26, 2016 at 11:27 AM, Junio C Hamano wrote: > Beat Bolli 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 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH 2/2] SubmittingPatches: hint at gitk's "Copy commit summary" command
Beat Bolli 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. -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
[PATCH 2/2] SubmittingPatches: hint at gitk's "Copy commit summary" command
Amend the section on referencing previous commits with a hint to the gitk command that was added exactly for this purpose. Signed-off-by: Beat Bolli --- Documentation/SubmittingPatches | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 500230c..94a1661 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -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. (3) Generate your patch using Git tools out of your commits. -- 2.7.2 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html