[PATCH] git-submodule documentation: fix foreach example
From: Miklos Vajna <hidden>
Date: 2016-06-15 22:47:00
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Backstick and apostrophe are asciidoc markup, so they should be escaped in order to get the expected result in the rendered manual page. Signed-off-by: Miklos Vajna <redacted> --- Documentation/asciidoc.conf | 1 + Documentation/git-submodule.txt | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-)
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index dc76e7f..b88d875 100644
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf@@ -17,6 +17,7 @@ caret=^ startsb=[ endsb=] tilde=~ +backstick=` ifdef::backend-docbook[] [linkgit-inlinemacro]
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 470bd75..8941ad7 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt@@ -141,8 +141,9 @@ 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 `git rev-parse HEAD`' will -show the path and currently checked out commit for each submodule. +As an example, +git submodule foreach \'echo $path {backstick}git +rev-parse HEAD{backstick}'+ will show the path and currently checked out +commit for each submodule. sync:: Synchronizes submodules' remote URL configuration setting
--
1.6.3.2