SubmittingPatches: be consistent with trailer markup
The rest of this section and (most importantly) the list has decided to use `<key>:`. So let’s use backticks (`) and a colon (:) throughout the document. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kristoffer Haugsbakk committed
Jun 19, 2026 at 07:44 UTC
89d86442441d354abddf53d06d440bc06500c738
1 file changed
+7
-7
Documentation/SubmittingPatches
+7
-7
@@ -374,7 +374,7 @@ or, on an older version of Git without support for --pretty=reference:
374
....
375
376
[[sign-off]]
377
-=== Certify your work by adding your `Signed-off-by` trailer
377
+=== Certify your work by adding your `Signed-off-by:` trailer
378
379
To improve tracking of who did what, we ask you to certify that you
380
wrote the patch or have the right to pass it on under the same license
@@ -411,7 +411,7 @@ d. I understand and agree that this project and the contribution
411
this project or the open source license(s) involved.
412
____
413
414
-you add a "Signed-off-by" trailer to your commit, that looks like
414
+you add a `Signed-off-by:` trailer to your commit, that looks like
415
this:
416
417
....
@@ -421,7 +421,7 @@ this:
421
This line can be added by Git if you run the git-commit command with
422
the -s option.
423
424
-Notice that you can place your own `Signed-off-by` trailer when
424
+Notice that you can place your own `Signed-off-by:` trailer when
425
forwarding somebody else's patch with the above rules for
426
D-C-O. Indeed you are encouraged to do so. Do not forget to
427
place an in-body "From: " line at the beginning to properly attribute
@@ -433,7 +433,7 @@ your patch differs from project to project, so it may be different
433
from that of the project you are accustomed to.
434
435
[[real-name]]
436
-Please use a known identity in the `Signed-off-by` trailer, since we cannot
436
+Please use a known identity in the `Signed-off-by:` trailer, since we cannot
437
accept anonymous contributions. It is common, but not required, to use some form
438
of your real name. We realize that some contributors are not comfortable doing
439
so or prefer to contribute under a pseudonym or preferred name and we can accept
@@ -485,7 +485,7 @@ Other projects might regularly refer to other kinds of data, like
485
particular are not used in this project.
486
487
Only capitalize the very first letter of the trailer, i.e. favor
488
-"Signed-off-by" over "Signed-Off-By" and "Acked-by:" over "Acked-By".
488
+`Signed-off-by:` over `Signed-Off-By:` and `Acked-by:` over `Acked-By:`.
489
490
[[ai]]
491
=== Use of Artificial Intelligence (AI)
@@ -607,7 +607,7 @@ Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on
607
how to submit updated versions of a patch series.
608
609
If your log message (including your name on the
610
-`Signed-off-by` trailer) is not writable in ASCII, make sure that
610
+`Signed-off-by:` trailer) is not writable in ASCII, make sure that
611
you send off a message in the correct encoding.
612
613
WARNING: Be wary of your MUAs word-wrap
@@ -627,7 +627,7 @@ previously sent.
627
The `git format-patch` command follows the best current practice to
628
format the body of an e-mail message. At the beginning of the
629
patch should come your commit message, ending with the
630
-`Signed-off-by` trailers, and a line that consists of three dashes,
630
+`Signed-off-by:` trailers, and a line that consists of three dashes,
631
followed by the diffstat information and the patch itself. If
632
you are forwarding a patch from somebody else, optionally, at
633
the beginning of the e-mail message just before the commit