threads / patch / 19954

patchgit-submodule documentation: fix foreach example

Subject: [PATCH] git-submodule documentation: fix foreach example

## tl;dr

3 messages between Jun 28, 2009 and Jun 28, 2009. Diffs are folded; open one to read it.

replies: 2people: 2as markdown or json

Miklos Vajna· Jun 28, 2009, 11:39 UTC · lore

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 <vmiklos@frugalware.org>
---
 Documentation/asciidoc.conf     |    1 +
 Documentation/git-submodule.txt |    5 +++--
 2 files changed, 4 insertions(+), 2 deletions(-)

Show changes to 2 files +4 −2

Documentation/asciidoc.conf, Documentation/git-submodule.txt

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=&#94;
 startsb=&#91;
 endsb=&#93;
 tilde=&#126;
+backstick=&#96;
 
 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· Jun 28, 2009, 12:34 UTC · re: Miklos Vajna · lore

Re: [PATCH] git-submodule documentation: fix foreach example

Miklos Vajna <vmiklos@frugalware.org> 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=&#91;
>  endsb=&#93;
>  tilde=&#126;
> +backstick=&#96;

It is 'backtick' (or 'backquote'), not 'backstick'. There is no 's' in its name.

-- 
Jakub Narebski
Poland
ShadeHawk on #git

Miklos Vajna· Jun 28, 2009, 12:55 UTC · re: Jakub Narebski · lore

[PATCH v2] git-submodule documentation: fix foreach example

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>
---

On Sun, Jun 28, 2009 at 05:34:23AM -0700, Jakub Narebski <jnareb@gmail.com> 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(-)

Show changes to 2 files +4 −2

Documentation/asciidoc.conf, Documentation/git-submodule.txt

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=&#94;
 startsb=&#91;
 endsb=&#93;
 tilde=&#126;
+backtick=&#96;
 
 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