]> git.ipfire.org Git - thirdparty/git.git/commitdiff
gitcli.txt: typeset pathnames as monospace
authorMartin Ågren <martin.agren@gmail.com>
Fri, 3 Jan 2025 11:33:31 +0000 (12:33 +0100)
committerJunio C Hamano <gitster@pobox.com>
Fri, 3 Jan 2025 16:23:59 +0000 (08:23 -0800)
Commit 1bc1e94091 (doc: option value may be separate for valid reasons,
2024-11-25) added a paragraph discussing tilde-expansion of, e.g.,
~/directory/file.

The tilde character has a special meaning to asciidoc tools. In this
particular case, AsciiDoc matches up the two tildes in "e.g.
~/directory/file or ~u/d/f" and sets the text between them using
subscript. In the manpage, where subscripting is not possible, this
renders as "e.g.  /directory/file oru/d/f".

These paths are literal values, which our coding guidelines want typeset
as verbatim using backticks. Do that. One effect of this is indeed that
the asciidoc tools stop interpreting tilde and other special characters.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitcli.txt

index bd62cbd0439508f7041526b1f434801da53ed3f3..fcd86d2eee003821ffa9d419bb3dc7691256a0d0 100644 (file)
@@ -91,7 +91,7 @@ scripting Git:
    written in the 'stuck' form.
 
  * Despite the above suggestion, when Arg is a path relative to the
-   home directory of a user, e.g. ~/directory/file or ~u/d/f, you
+   home directory of a user, e.g. `~/directory/file` or `~u/d/f`, you
    may want to use the separate form, e.g. `git foo --file ~/mine`,
    not `git foo --file=~/mine`.  The shell will expand `~/` in the
    former to your home directory, but most shells keep the tilde in