docs: make sure literal "->" isn't converted to arrow
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>
Jeff King committed
May 26, 2011 at 22:32 UTC
715e716a1b5bc1bc71715286e7a10b7e0c3188e8
2 files changed
+5
-5
Documentation/git-cvsserver.txt
+1
-1
@@ -252,7 +252,7 @@ Configuring database backend
252
253
'git-cvsserver' uses the Perl DBI module. Please also read
254
its documentation if changing these variables, especially
255
-about `DBI->connect()`.
255
+about `DBI\->connect()`.
256
257
gitcvs.dbname::
258
Database name. The exact meaning depends on the
Documentation/git-status.txt
+4
-4
@@ -94,12 +94,12 @@ In the short-format, the status of each path is shown as
94
95
XY PATH1 -> PATH2
96
97
-where `PATH1` is the path in the `HEAD`, and the ` -> PATH2` part is
97
+where `PATH1` is the path in the `HEAD`, and the ` \-> PATH2` part is
98
shown only when `PATH1` corresponds to a different path in the
99
index/worktree (i.e. the file is renamed). The 'XY' is a two-letter
100
status code.
101
102
-The fields (including the `->`) are separated from each other by a
102
+The fields (including the `\->`) are separated from each other by a
103
single space. If a filename contains whitespace or other nonprintable
104
characters, that field will be quoted in the manner of a C string
105
literal: surrounded by ASCII double quote (34) characters, and with
@@ -165,8 +165,8 @@ format, with a few exceptions:
165
166
There is also an alternate -z format recommended for machine parsing. In
167
that format, the status field is the same, but some other things
168
-change. First, the '->' is omitted from rename entries and the field
169
-order is reversed (e.g 'from -> to' becomes 'to from'). Second, a NUL
168
+change. First, the '\->' is omitted from rename entries and the field
169
+order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
170
(ASCII 0) follows each filename, replacing space as a field separator
171
and the terminating newline (but a space still separates the status
172
field from the first filename). Third, filenames containing special