[PATCH v2 0/2] git-show-ref: fix asciidoc formatting

[PATCH v2 0/2] git-show-ref: fix asciidoc formatting

[mhagger]

From: Michael Haggerty <mhagger@alum.mit.edu>

This topic was discussed before [1].  I hereby try again, with a bit
more information in the commit messages for posterity.

The patches apply to master or maint, whatever you prefer.

[1] http://comments.gmane.org/gmane.comp.version-control.git/183940

Michael Haggerty (2):
  git-show-ref: fix escaping in asciidoc source
  git-show-ref doc: typeset regexp in fixed width font

 Documentation/git-show-ref.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

-- 
1.7.8.3

[PATCH v2 1/2] git-show-ref: fix escaping in asciidoc source

[mhagger]

From: Michael Haggerty <mhagger@alum.mit.edu>

Two "^" characters were incorrectly being interpreted as markup for
superscripting.  Fix them by writing them as attribute references
"{caret}".

Although a single "^" character in a paragraph cannot be
misinterpreted in this way, also write other "^" characters as
"{caret}" in the interest of good hygiene (unless they are in literal
paragraphs, of course, in which context attribute references are not
recognized).

Spell "{}" consistently, namely *not* quoted as "\{\}".  Since the
braces are empty, they cannot be interpreted as an attribute
reference, and either spelling is OK.  So arbitrarily choose one
variation and use it consistently.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
 Documentation/git-show-ref.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 3c45895..8dfcbe3 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -44,7 +44,7 @@ OPTIONS
 -d::
 --dereference::
 
-	Dereference tags into object IDs as well. They will be shown with "^{}"
+	Dereference tags into object IDs as well. They will be shown with "{caret}{}"
 	appended.
 
 -s::
@@ -73,9 +73,9 @@ OPTIONS
 --exclude-existing[=<pattern>]::
 
 	Make 'git show-ref' act as a filter that reads refs from stdin of the
-	form "^(?:<anything>\s)?<refname>(?:{backslash}{caret}\{\})?$"
+	form "{caret}(?:<anything>\s)?<refname>(?:{backslash}{caret}{})?$"
 	and performs the following actions on each:
-	(1) strip "^{}" at the end of line if any;
+	(1) strip "{caret}{}" at the end of line if any;
 	(2) ignore if pattern is provided and does not head-match refname;
 	(3) warn if refname is not a well-formed refname and skip;
 	(4) ignore if refname is a ref that exists in the local repository;
-- 
1.7.8.3

[PATCH v2 2/2] git-show-ref doc: typeset regexp in fixed width font

[mhagger]

From: Michael Haggerty <mhagger@alum.mit.edu>


Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
Optional; I think it looks better.

 Documentation/git-show-ref.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 8dfcbe3..fcee000 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -73,7 +73,7 @@ OPTIONS
 --exclude-existing[=<pattern>]::
 
 	Make 'git show-ref' act as a filter that reads refs from stdin of the
-	form "{caret}(?:<anything>\s)?<refname>(?:{backslash}{caret}{})?$"
+	form "`{caret}(?:<anything>\s)?<refname>(?:{backslash}{caret}{})?$`"
 	and performs the following actions on each:
 	(1) strip "{caret}{}" at the end of line if any;
 	(2) ignore if pattern is provided and does not head-match refname;
-- 
1.7.8.3

Re: [PATCH v2 2/2] git-show-ref doc: typeset regexp in fixed width font

[Junio C Hamano]

mhagger@alum.mit.edu writes:

> From: Michael Haggerty <mhagger@alum.mit.edu>
>
>
> Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
> ---
> Optional; I think it looks better.

I agree it looks better, too, as long as everybody's copy of AsciiDoc
groks it. I see "`<something>`" in many places in the other pages, so this
should be safe.

Thanks for resending. Will queue.