summaryrefslogtreecommitdiff
path: root/Documentation/revisions.txt
diff options
context:
space:
mode:
authorLibravatar Jeff King <peff@peff.net>2017-02-13 16:05:49 -0500
committerLibravatar Junio C Hamano <gitster@pobox.com>2017-02-13 14:05:40 -0800
commite91461b3323ad75e02d2f4fa65b8482744f26036 (patch)
tree7bc0632aac773f64ded5238adcb831885d14f81f /Documentation/revisions.txt
parentGit 2.11.1 (diff)
downloadtgif-e91461b3323ad75e02d2f4fa65b8482744f26036.tar.xz
docs/git-submodule: fix unbalanced quote
The documentation gives an example of the submodule foreach command that uses both backticks and single-quotes. We stick the whole thing inside "+" markers to make it monospace, but the inside punctuation still needs escaping. We handle the backticks with "{backtick}", and use backslash-escaping for the single-quotes. But we missed the escaping on the second quote. Fortunately, asciidoc renders this unbalanced quote as we want (showing the quote), but asciidoctor does not. We could fix it by adding the missing backslash. However, let's take a step back. Even when rendered correctly, it's hard to read a long command stuck into the middle of a paragraph, and the important punctuation is hard to notice. Let's instead bump it into its own single-line code block. That makes both the source and the rendered result more readable, and as a bonus we don't have to worry about quoting at all. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/revisions.txt')
0 files changed, 0 insertions, 0 deletions