Skip to content

Commit

Permalink
docs: make sure literal "->" isn't converted to arrow
Browse files Browse the repository at this point in the history
Recent versions of asciidoc will treat "->" as a
single-glyph arrow symbol, unless it is inside a literal
code block. This is a problem if we are discussing literal
output and want to show the ASCII characters.

Our usage falls into three categories:

  1. Inside a code block. These can be left as-is.

  2. Discussing literal output or code, but inside a
     paragraph. This patch escapes these as "\->".

  3. Using the arrow as a symbolic element, such as "use the
     Edit->Account Settings menu". In this case, the
     arrow symbol is preferable, so we leave it as-is.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Jeff King authored and Junio C Hamano committed May 27, 2011
1 parent fc17df0 commit 715e716
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Documentation/git-cvsserver.txt
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ Configuring database backend

'git-cvsserver' uses the Perl DBI module. Please also read
its documentation if changing these variables, especially
about `DBI->connect()`.
about `DBI\->connect()`.

gitcvs.dbname::
Database name. The exact meaning depends on the
Expand Down
8 changes: 4 additions & 4 deletions Documentation/git-status.txt
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ In the short-format, the status of each path is shown as

XY PATH1 -> PATH2

where `PATH1` is the path in the `HEAD`, and the ` -> PATH2` part is
where `PATH1` is the path in the `HEAD`, and the ` \-> PATH2` part is
shown only when `PATH1` corresponds to a different path in the
index/worktree (i.e. the file is renamed). The 'XY' is a two-letter
status code.

The fields (including the `->`) are separated from each other by a
The fields (including the `\->`) are separated from each other by a
single space. If a filename contains whitespace or other nonprintable
characters, that field will be quoted in the manner of a C string
literal: surrounded by ASCII double quote (34) characters, and with
Expand Down Expand Up @@ -165,8 +165,8 @@ format, with a few exceptions:

There is also an alternate -z format recommended for machine parsing. In
that format, the status field is the same, but some other things
change. First, the '->' is omitted from rename entries and the field
order is reversed (e.g 'from -> to' becomes 'to from'). Second, a NUL
change. First, the '\->' is omitted from rename entries and the field
order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
(ASCII 0) follows each filename, replacing space as a field separator
and the terminating newline (but a space still separates the status
field from the first filename). Third, filenames containing special
Expand Down

0 comments on commit 715e716

Please sign in to comment.