advice: use backticks for verbatim
Use backticks for inline-verbatim rather than single quotes. Also quote the unquoted ref globs. Also replace “the add command” with “`git add`”. Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Kristoffer Haugsbakk committed
Mar 5, 2024 at 21:29 UTC
3ccc4782ce9b454c0428a7d6a4d0fd7c3d1eaea7
1 file changed
+7
-7
Documentation/config/advice.txt
+7
-7
@@ -2,14 +2,14 @@ advice.*::
2
These variables control various optional help messages designed to
3
aid new users. When left unconfigured, Git will give the message
4
alongside instructions on how to squelch it. You can tell Git
5
- that you do not need the help message by setting these to 'false':
5
+ that you do not need the help message by setting these to `false`:
6
+
7
--
8
addEmbeddedRepo::
9
Shown when the user accidentally adds one
10
git repo inside of another.
11
addEmptyPathspec::
12
- Shown when the user runs the add command without providing
12
+ Shown when the user runs `git add` without providing
13
the pathspec parameter.
14
addIgnoredFile::
15
Shown when the user attempts to add an ignored file to
@@ -75,7 +75,7 @@ advice.*::
75
non-fast-forward update to the current branch.
76
pushNonFFMatching::
77
Shown when the user ran linkgit:git-push[1] and pushed
78
- 'matching refs' explicitly (i.e. used ':', or
78
+ 'matching refs' explicitly (i.e. used `:`, or
79
specified a refspec that isn't the current branch) and
80
it resulted in a non-fast-forward error.
81
pushRefNeedsUpdate::
@@ -87,12 +87,12 @@ advice.*::
87
guess based on the source and destination refs what
88
remote ref namespace the source belongs in, but where
89
we can still suggest that the user push to either
90
- refs/heads/* or refs/tags/* based on the type of the
90
+ `refs/heads/*` or `refs/tags/*` based on the type of the
91
source object.
92
pushUpdateRejected::
93
- Set this variable to 'false' if you want to disable
94
- 'pushNonFFCurrent', 'pushNonFFMatching', 'pushAlreadyExists',
95
- 'pushFetchFirst', 'pushNeedsForce', and 'pushRefNeedsUpdate'
93
+ Set this variable to `false` if you want to disable
94
+ `pushNonFFCurrent`, `pushNonFFMatching`, `pushAlreadyExists`,
95
+ `pushFetchFirst`, `pushNeedsForce`, and `pushRefNeedsUpdate`
96
simultaneously.
97
resetNoRefresh::
98
Shown when linkgit:git-reset[1] takes more than 2