Documentation/log: add a CONFIGURATION section
Add a configuration section summarizing variables that affect the log family of commands. Cc: Thomas Rast <trast@student.ethz.ch> Cc: Jakub Narebski <jnareb@gmail.com> 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:30 UTC
59893a88f96b3ed4223c20942fd3db5d8c43f7c0
1 file changed
+42
Documentation/git-log.txt
+42
@@ -132,6 +132,48 @@ Discussion
132
133
include::i18n.txt[]
134
135
+Configuration
136
+-------------
137
+
138
+See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
139
+for settings related to diff generation.
140
+
141
+format.pretty::
142
+ Default for the `--format` option. (See "PRETTY FORMATS" above.)
143
+ Defaults to "medium".
144
+
145
+i18n.logOutputEncoding::
146
+ Encoding to use when displaying logs. (See "Discussion", above.)
147
+ Defaults to the value of `i18n.commitEncoding` if set, UTF-8
148
+ otherwise.
149
+
150
+log.date::
151
+ Default format for human-readable dates. (Compare the
152
+ `--date` option.) Defaults to "default", which means to write
153
+ dates like `Sat May 8 19:35:34 2010 -0500`.
154
+
155
+log.showroot::
156
+ If `false`, 'git log' and related commands will not treat the
157
+ initial commit as a big creation event. Any root commits in
158
+ `git log -p` output would be shown without a diff attached.
159
+ The default is `true`.
160
+
161
+mailmap.file::
162
+ See linkgit:git-shortlog[1].
163
+
164
+notes.displayRef::
165
+ Which refs, in addition to the default set by `core.notesRef`
166
+ or 'GIT_NOTES_REF', to read notes from when showing commit
167
+ messages with the 'log' family of commands. See
168
+ linkgit:git-notes[1].
169
++
170
+May be an unabbreviated ref name or a glob and may be specified
171
+multiple times. A warning will be issued for refs that do not exist,
172
+but a glob that does not match any refs is silently ignored.
173
++
174
+This setting can be disabled by the `--no-standard-notes` option,
175
+overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
176
+and supplemented by the `--show-notes` option.
177
178
Author
179
------