summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2017-02-13 21:05:49 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-02-13 22:05:40 (GMT)
commite91461b3323ad75e02d2f4fa65b8482744f26036 (patch)
tree7bc0632aac773f64ded5238adcb831885d14f81f /Documentation
parent3b9e3c2cede15057af3ff8076c45ad5f33829436 (diff)
downloadgit-e91461b3323ad75e02d2f4fa65b8482744f26036.zip
git-e91461b3323ad75e02d2f4fa65b8482744f26036.tar.gz
git-e91461b3323ad75e02d2f4fa65b8482744f26036.tar.bz2
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')
-rw-r--r--Documentation/git-submodule.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index d841573..fc4fb64 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -227,9 +227,12 @@ foreach::
the processing to terminate. This can be overridden by adding '|| :'
to the end of the command.
+
-As an example, +git submodule foreach \'echo $path {backtick}git
-rev-parse HEAD{backtick}'+ will show the path and currently checked out
-commit for each submodule.
+As an example, the command below will show the path and currently
+checked out commit for each submodule:
++
+--------------
+git submodule foreach 'echo $path `git rev-parse HEAD`'
+--------------
sync::
Synchronizes submodules' remote URL configuration setting