Skip to content

Commit c9e3d47

Browse files
tmzullingergitster
authored andcommitted
doc/SubmittingPatches: improve text formatting
049e64a ("Documentation: convert SubmittingPatches to AsciiDoc", 2017-11-12) changed the `git blame` and `git shortlog` examples given in the section on sending your patches. In order to italicize the `$path` argument the commands are enclosed in plus characters as opposed to backticks. The difference between the quoting methods is that backtick enclosed text is not subject to further expansion. This formatting makes reading SubmittingPatches in a git clone a little more difficult. In addition to the underscores around `$path` the `--` chars in `git shortlog --no-merges` must be replaced with `{litdd}`. Use backticks to quote these commands. The italicized `$path` is lost from the html version but the commands can be read (and copied) more easily by users reading the text version. These readers are more likely to use the commands while submitting patches. Make it easier for them. Signed-off-by: Todd Zullinger <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 049e64a commit c9e3d47

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/SubmittingPatches

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ not a text/plain, it's something else.
256256

257257
Send your patch with "To:" set to the mailing list, with "cc:" listing
258258
people who are involved in the area you are touching (the output from
259-
+git blame _$path_+ and +git shortlog {litdd}no-merges _$path_+ would help to
259+
`git blame $path` and `git shortlog --no-merges $path` would help to
260260
identify them), to solicit comments and reviews.
261261

262262
:1: footnote:[The current maintainer: [email protected]]

0 commit comments

Comments
 (0)