diff mbox series

[1/2] doc: revisions: fix missing escape

Message ID 20230504163421.100400-2-felipe.contreras@gmail.com (mailing list archive)
State New, archived
Headers show
Series doc: revisions: fixes and cleanups | expand

Commit Message

Felipe Contreras May 4, 2023, 4:34 p.m. UTC
In AsciiDoc `{foo}` is an attribute, if one doesn't want the attribute
replaced the left curly brace symbol has to be escaped.

For some reason asciidoc.py skips the whole line otherwise:

  --- a/gitrevisions.7
  +++ b/gitrevisions.7
  @@ -112,8 +112,10 @@ SPECIFYING REVISIONS

          [<branchname>]@{upstream}, e.g. master@{upstream}, @{u}
              A branch B may be set up to build on top of a branch X (configured
  -           with branch.<name>.merge) at a remote R (configured with the branch
  -           X taken from remote R, typically found at refs/remotes/R/X.
  +           with branch.<name>.merge) at a remote R (configured with
  +           branch.<name>.remote). B@{u} refers to the remote-tracking branch
  +           for the branch X taken from remote R, typically found at
  +           refs/remotes/R/X.

          [<branchname>]@{push}, e.g. master@{push}, @{push}
              The suffix @{push} reports the branch "where we would push to" if

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/revisions.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 9aa58052bc..af764de153 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -99,7 +99,7 @@  some output processing may assume ref names in UTF-8.
 '[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
   A branch B may be set up to build on top of a branch X (configured with
   `branch.<name>.merge`) at a remote R (configured with
-  `branch.<name>.remote`). B@{u} refers to the remote-tracking branch for
+  `branch.<name>.remote`). B@\{u} refers to the remote-tracking branch for
   the branch X taken from remote R, typically found at `refs/remotes/R/X`.
 
 '[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::