@matheusbsbs / matheus-bagliano / commits / b67a603f63

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>

Martin Ågren committed Jan 3, 2025 at 12:33 UTC b67a603f6360051f174a00f8d10dc088dc7093be

1 file changed +1 -1

Documentation/gitcli.txt

+1 -1

@@ -91,7 +91,7 @@ scripting Git:

91 written in the 'stuck' form.

93 * Despite the above suggestion, when Arg is a path relative to the

94 - home directory of a user, e.g. ~/directory/file or ~u/d/f, you

94 + home directory of a user, e.g. `~/directory/file` or `~u/d/f`, you

95 may want to use the separate form, e.g. `git foo --file ~/mine`,

96 not `git foo --file=~/mine`. The shell will expand `~/` in the

97 former to your home directory, but most shells keep the tilde in