# [PATCH] git-submodule documentation: fix foreach example 3 messages from 2009-06-28 to 2009-06-28. Participants: Miklos Vajna, Jakub Narebski. Thread: https://gitlist.dev/t/19954 ## Miklos Vajna, 2009-06-28 11:39 Subject: [PATCH] git-submodule documentation: fix foreach example Message-ID: <20090628113931.GC10895@genesis.frugalware.org> URL: https://gitlist.dev/e/20090628113931.GC10895%40genesis.frugalware.org ``` 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 --- 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 ``` ## Jakub Narebski, 2009-06-28 12:34 Subject: Re: [PATCH] git-submodule documentation: fix foreach example Message-ID: URL: https://gitlist.dev/e/m3tz20wmzv.fsf%40localhost.localdomain In-Reply-To: <20090628113931.GC10895@genesis.frugalware.org> ``` Miklos Vajna writes: > Backstick and apostrophe are asciidoc markup, so they should be escaped > in order to get the expected result in the rendered manual page. [...] > startsb=[ > endsb=] > tilde=~ > +backstick=` It is 'backtick' (or 'backquote'), not 'backstick'. There is no 's' in its name. -- Jakub Narebski Poland ShadeHawk on #git ``` ## Miklos Vajna, 2009-06-28 12:55 Subject: [PATCH v2] git-submodule documentation: fix foreach example Message-ID: <20090628125545.GH10895@genesis.frugalware.org> URL: https://gitlist.dev/e/20090628125545.GH10895%40genesis.frugalware.org In-Reply-To: ``` 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 --- On Sun, Jun 28, 2009 at 05:34:23AM -0700, Jakub Narebski wrote: > It is 'backtick' (or 'backquote'), not 'backstick'. There is no 's' > in its name. Ah, true. Thanks, fixed. 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=~ +backtick=` 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 {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 -- 1.6.3.2 ```