git-submodule documentation: fix foreach example
authorMiklos Vajna <vmiklos@frugalware.org>
Sun, 28 Jun 2009 12:55:45 +0000 (14:55 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 30 Jun 2009 18:17:54 +0000 (11:17 -0700)
Backtick 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 <vmiklos@frugalware.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/asciidoc.conf
Documentation/git-submodule.txt

index dc76e7f073f23cd911da0b0d0d49b72726576f1a..87a90f2c3fd48bbb593a2cef135310f88d87e4b4 100644 (file)
@@ -17,6 +17,7 @@ caret=&#94;
 startsb=&#91;
 endsb=&#93;
 tilde=&#126;
+backtick=&#96;
 
 ifdef::backend-docbook[]
 [linkgit-inlinemacro]
index 3b8df4467377d73d613f76875c725cbf8544ee77..15b34d3760820655c76da3d3b8508db81c8e8dae 100644 (file)
@@ -137,8 +137,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 {backtick}git
+rev-parse HEAD{backtick}'+ will show the path and currently checked out
+commit for each submodule.
 
 sync::
        Synchronizes submodules' remote URL configuration setting