summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Todd Zullinger <tmz@pobox.com>2018-01-02 10:33:50 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2018-01-03 13:34:56 -0800
commitc9e3d472f9b954c7ab720b37d8ee55837640758f (patch)
tree012b1fa1c9f257d31e2845192f0d9f49af6fca82
parentDocumentation: convert SubmittingPatches to AsciiDoc (diff)
downloadtgif-c9e3d472f9b954c7ab720b37d8ee55837640758f.tar.xz
doc/SubmittingPatches: improve text formatting
049e64aa50 ("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 <tmz@pobox.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/SubmittingPatches2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 17419f7901..b5d4bdde91 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -256,7 +256,7 @@ not a text/plain, it's something else.
Send your patch with "To:" set to the mailing list, with "cc:" listing
people who are involved in the area you are touching (the output from
-+git blame _$path_+ and +git shortlog {litdd}no-merges _$path_+ would help to
+`git blame $path` and `git shortlog --no-merges $path` would help to
identify them), to solicit comments and reviews.
:1: footnote:[The current maintainer: gitster@pobox.com]