Skip to content

Commit b67a603

Browse files
Martin Ågrengitster
authored andcommitted
gitcli.txt: typeset pathnames as monospace
Commit 1bc1e94 (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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1bc1e94 commit b67a603

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/gitcli.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ scripting Git:
9191
written in the 'stuck' form.
9292

9393
* 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
9595
may want to use the separate form, e.g. `git foo --file ~/mine`,
9696
not `git foo --file=~/mine`. The shell will expand `~/` in the
9797
former to your home directory, but most shells keep the tilde in

0 commit comments

Comments
 (0)