Documentation/notes: add configuration section
Copy the descriptions of configuration variables from git-config.1. Once the descriptions have been ironed out, it would be nice to refactor them to share text, but for now it is simplest to experiment with separate copies. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
May 8, 2010 at 22:21 UTC
ed9098fda2c8d178aad3a47c0c2f97474c60e82c
1 file changed
+59
Documentation/git-notes.txt
+59
@@ -183,6 +183,65 @@ with 'git log', so if you use such notes, you'll probably need to write
183
some special-purpose tools to do something useful with them.
184
185
186
+CONFIGURATION
187
+-------------
188
+
189
+core.notesRef::
190
+ When showing commit messages, also show notes which are stored in
191
+ the given ref. The ref must be fully qualified. If the given
192
+ ref does not exist, it is not an error but means that no
193
+ notes should be printed.
194
++
195
+This setting defaults to "refs/notes/commits", and it can be overridden by
196
+the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1].
197
+
198
+notes.displayRef::
199
+ The (fully qualified) refname from which to show notes when
200
+ showing commit messages. The value of this variable can be set
201
+ to a glob, in which case notes from all matching refs will be
202
+ shown. You may also specify this configuration variable
203
+ several times. A warning will be issued for refs that do not
204
+ exist, but a glob that does not match any refs is silently
205
+ ignored.
206
++
207
+This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
208
+environment variable, which must be a colon separated list of refs or
209
+globs.
210
++
211
+The effective value of "core.notesRef" (possibly overridden by
212
+GIT_NOTES_REF) is also implicitly added to the list of refs to be
213
+displayed.
214
+
215
+notes.rewrite.<command>::
216
+ When rewriting commits with <command> (currently `amend` or
217
+ `rebase`) and this variable is set to `true`, git
218
+ automatically copies your notes from the original to the
219
+ rewritten commit. Defaults to `true`, but see
220
+ "notes.rewriteRef" below.
221
+
222
+notes.rewriteMode::
223
+ When copying notes during a rewrite (see the
224
+ "notes.rewrite.<command>" option), determines what to do if
225
+ the target commit already has a note. Must be one of
226
+ `overwrite`, `concatenate`, or `ignore`. Defaults to
227
+ `concatenate`.
228
++
229
+This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
230
+environment variable.
231
+
232
+notes.rewriteRef::
233
+ When copying notes during a rewrite, specifies the (fully
234
+ qualified) ref whose notes should be copied. The ref may be a
235
+ glob, in which case notes in all matching refs will be copied.
236
+ You may also specify this configuration several times.
237
++
238
+Does not have a default value; you must configure this variable to
239
+enable note rewriting.
240
++
241
+This setting can be overridden with the `GIT_NOTES_REWRITE_REF`
242
+environment variable, which must be a colon separated list of refs or
243
+globs.
244
+
245
Author
246
------
247
Written by Johannes Schindelin <johannes.schindelin@gmx.de> and