diff options
| author | Jeff King <peff@peff.net> | 2011-05-26 22:32:41 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-05-26 22:15:38 -0700 |
| commit | 715e716a1b5bc1bc71715286e7a10b7e0c3188e8 (patch) | |
| tree | aedfe9a077ca1bac78c0da00dab813cd131a0c1d /Documentation/git-status.txt | |
| parent | fc17df03442185a23583b959fc70617b69ceb0ca (diff) | |
| download | git-715e716a1b5bc1bc71715286e7a10b7e0c3188e8.tar.gz git-715e716a1b5bc1bc71715286e7a10b7e0c3188e8.tar.xz | |
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>
Diffstat (limited to 'Documentation/git-status.txt')
| -rw-r--r-- | Documentation/git-status.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index edacf6b93..38cb741f1 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -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 @@ -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 |