author | Jeff King <peff@peff.net> | |
Fri, 27 May 2011 02:32:41 +0000 (22:32 -0400) | ||
committer | Junio C Hamano <gitster@pobox.com> | |
Fri, 27 May 2011 05:15:38 +0000 (22:15 -0700) | ||
commit | 715e716a1b5bc1bc71715286e7a10b7e0c3188e8 | |
tree | aedfe9a077ca1bac78c0da00dab813cd131a0c1d | tree | snapshot |
parent | fc17df03442185a23583b959fc70617b69ceb0ca | commit | diff |
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>
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>
Documentation/git-cvsserver.txt | diff | blob | history | |
Documentation/git-status.txt | diff | blob | history |