[PATCH] clean up confusing suggestion for commit references
- From
Heiko Voigt <hvoigt@hvoigt.net>
- Date
- Oct 7, 2016, 09:56 UTC
- Message-ID
- <20161007095638.GA55445@book.hvoigt.net>
The description for referencing commits looks as if it is contradicting the example, since it is itself enclosed in double quotes. Lets use single quotes around the description and include the double quotes in the description so it matches the example. --- Sorry for opening this up again but I just looked up the format and was like: "Umm, which one is now the correct one..."
For this makes more sense. What do others think?
Cheers Heiko
Documentation/SubmittingPatches | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 08352de..692f4ce 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -122,7 +122,7 @@ without external resources. Instead of giving a URL to a mailing list 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)", +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)
-- 2.10.0.645.g54f1e86