Skip to contentSkip to conversation

SubmittingPatches: use usual capitalization in the log message body

PATCH In review Junio C Hamano 2 participants 2 messages Oct 7, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 SubmittingPatches: use usual capitalization in the log message body

Update the description of the summary section to clarify that the "do not capitalize" rule applies only the word after the "<area>:" prefix of the title and nowhere else. This hopefully will prevent folks from writing their proposed log message in all lowercase.

---
 Documentation/SubmittingPatches | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/SubmittingPatches +3 -1
index 5bd795e5db..927f7329a5 100644
@@ -153,7 +153,9 @@ files you are modifying to see the current conventions.
 
 [[summary-section]]
 The title sentence after the "area:" prefix omits the full stop at the
-end, and its first word is not capitalized unless there is a reason to
+end, and its first word is not capitalized (the omission
+of capitalization applies only to the word after the "area:"
+prefix of the title) unless there is a reason to
 capitalize it other than because it is the first word in the sentence.
 E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt:
 improve...", not "githooks.txt: Improve...".  But "refs: HEAD is also
#1 lore raw
Quoted 3 lines · Junio C Hamano
---
 Documentation/SubmittingPatches | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Thanks, looks good to me. Hopefully readers of SubmittingPatches will take note ;-).

Thanks,
Taylor