]> git.ipfire.org Git - thirdparty/git.git/commit
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)
commitb67a603f6360051f174a00f8d10dc088dc7093be
tree21537970caeb1640aba436497b95359b601037a4
parent1bc1e940918cd44cc78bff1dfd518e16fc5bad57
gitcli.txt: typeset pathnames as monospace

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