[PATCH] git-submodule documentation: fix foreach example

DORMANTno replies

3 messages, 2 authors, 2016-06-15 · open the first message on its own page

[PATCH] git-submodule documentation: fix foreach example

From: Miklos Vajna <hidden>
Date: 2016-06-15 22:47:00

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=&#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

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

From: Jakub Narebski <hidden>
Date: 2016-06-15 22:47:00

Miklos Vajna [off-list ref] 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

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

From: Miklos Vajna <hidden>
Date: 2016-06-15 22:47:00

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

On Sun, Jun 28, 2009 at 05:34:23AM -0700, Jakub Narebski [off-list ref] 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=&#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

`h`	back out one level
`j`	next message in thread
`k`	previous message in thread
`l`	drill in
`Esc`	close help / fold thread tree
`?`	toggle this help