summaryrefslogtreecommitdiffstats
path: root/Documentation/gitcli.txt
diff options
context:
space:
mode:
authorMartin Ågren <martin.agren@gmail.com>2025-01-03 12:33:31 +0100
committerJunio C Hamano <gitster@pobox.com>2025-01-03 17:23:59 +0100
commitb67a603f6360051f174a00f8d10dc088dc7093be (patch)
tree21537970caeb1640aba436497b95359b601037a4 /Documentation/gitcli.txt
parentdoc: option value may be separate for valid reasons (diff)
downloadgit-b67a603f6360051f174a00f8d10dc088dc7093be.tar.xz
git-b67a603f6360051f174a00f8d10dc088dc7093be.zip
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>
Diffstat (limited to '')
-rw-r--r--Documentation/gitcli.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index bd62cbd043..fcd86d2eee 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -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