@matheusbsbs / matheus-bagliano / commits / 6ab260809b

git-show-ref: fix escaping in asciidoc source

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> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Michael Haggerty committed Jan 13, 2012 at 17:39 UTC 6ab260809b61b622e833771fbe08874f14a7e544

1 file changed +3 -3

Documentation/git-show-ref.txt

+3 -3

@@ -44,7 +44,7 @@ OPTIONS

44 -d::

45 --dereference::

47 - Dereference tags into object IDs as well. They will be shown with "^{}"

47 + Dereference tags into object IDs as well. They will be shown with "{caret}{}"

48 appended.

50 -s::

@@ -73,9 +73,9 @@ OPTIONS

73 --exclude-existing[=<pattern>]::

75 Make 'git show-ref' act as a filter that reads refs from stdin of the

76 - form "^(?:<anything>\s)?<refname>(?:{backslash}{caret}\{\})?$"

76 + form "{caret}(?:<anything>\s)?<refname>(?:{backslash}{caret}{})?$"

77 and performs the following actions on each:

78 - (1) strip "^{}" at the end of line if any;

78 + (1) strip "{caret}{}" at the end of line if any;

79 (2) ignore if pattern is provided and does not head-match refname;

80 (3) warn if refname is not a well-formed refname and skip;

81 (4) ignore if refname is a ref that exists in the local repository;