advice: Document that they all default to true
By definition, the default value of "advice.*" variables must be true and they all control various additional help messages that are designed to aid new users. Setting one to false is to tell Git that the user understands the nature of the error and does not need the additional verbose help message. Also fix the asciidoc markup for linkgit:git-checkout[1] in the description of the detachedHead advice by removing an excess colon. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
Dec 18, 2011 at 21:35 UTC
26e94af0ba2f35438bab4a88caa4a16f5e056bac
1 file changed
+8
-11
Documentation/config.txt
+8
-11
@@ -115,35 +115,32 @@ in the appropriate manual page. You will find a description of non-core
115
porcelain configuration variables in the respective porcelain documentation.
116
117
advice.*::
118
- When set to 'true', display the given optional help message.
119
- When set to 'false', do not display. The configuration variables
120
- are:
118
+ These variables control various optional help messages designed to
119
+ aid new users. All 'advice.*' variables default to 'true', and you
120
+ can tell Git that you do not need help by setting these to 'false':
121
+
122
--
123
pushNonFastForward::
124
Advice shown when linkgit:git-push[1] refuses
125
- non-fast-forward refs. Default: true.
125
+ non-fast-forward refs.
126
statusHints::
127
Directions on how to stage/unstage/add shown in the
128
output of linkgit:git-status[1] and the template shown
129
- when writing commit messages. Default: true.
129
+ when writing commit messages.
130
commitBeforeMerge::
131
Advice shown when linkgit:git-merge[1] refuses to
132
merge to avoid overwriting local changes.
133
- Default: true.
133
resolveConflict::
134
Advices shown by various commands when conflicts
135
prevent the operation from being performed.
137
- Default: true.
136
implicitIdentity::
137
Advice on how to set your identity configuration when
138
your information is guessed from the system username and
141
- domain name. Default: true.
142
-
139
+ domain name.
140
detachedHead::
144
- Advice shown when you used linkgit::git-checkout[1] to
141
+ Advice shown when you used linkgit:git-checkout[1] to
142
move to the detach HEAD state, to instruct how to create
146
- a local branch after the fact. Default: true.
143
+ a local branch after the fact.
144
--
145
146
core.fileMode::