doc/git-log: move "-t" into diff-options list
[git] / Documentation / git-log.txt
1 git-log(1)
2 ==========
3
4 NAME
5 ----
6 git-log - Show commit logs
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git log' [<options>] [<revision range>] [[--] <path>...]
13
14 DESCRIPTION
15 -----------
16 Shows the commit logs.
17
18 The command takes options applicable to the `git rev-list`
19 command to control what is shown and how, and options applicable to
20 the `git diff-*` commands to control how the changes
21 each commit introduces are shown.
22
23
24 OPTIONS
25 -------
26
27 --follow::
28         Continue listing the history of a file beyond renames
29         (works only for a single file).
30
31 --no-decorate::
32 --decorate[=short|full|auto|no]::
33         Print out the ref names of any commits that are shown. If 'short' is
34         specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
35         'refs/remotes/' will not be printed. If 'full' is specified, the
36         full ref name (including prefix) will be printed. If 'auto' is
37         specified, then if the output is going to a terminal, the ref names
38         are shown as if 'short' were given, otherwise no ref names are
39         shown. The default option is 'short'.
40
41 --decorate-refs=<pattern>::
42 --decorate-refs-exclude=<pattern>::
43         If no `--decorate-refs` is given, pretend as if all refs were
44         included.  For each candidate, do not use it for decoration if it
45         matches any patterns given to `--decorate-refs-exclude` or if it
46         doesn't match any of the patterns given to `--decorate-refs`. The
47         `log.excludeDecoration` config option allows excluding refs from
48         the decorations, but an explicit `--decorate-refs` pattern will
49         override a match in `log.excludeDecoration`.
50
51 --source::
52         Print out the ref name given on the command line by which each
53         commit was reached.
54
55 --[no-]mailmap::
56 --[no-]use-mailmap::
57         Use mailmap file to map author and committer names and email
58         addresses to canonical real names and email addresses. See
59         linkgit:git-shortlog[1].
60
61 --full-diff::
62         Without this flag, `git log -p <path>...` shows commits that
63         touch the specified paths, and diffs about the same specified
64         paths.  With this, the full diff is shown for commits that touch
65         the specified paths; this means that "<path>..." limits only
66         commits, and doesn't limit diff for those commits.
67 +
68 Note that this affects all diff-based output types, e.g. those
69 produced by `--stat`, etc.
70
71 --log-size::
72         Include a line ``log size <number>'' in the output for each commit,
73         where <number> is the length of that commit's message in bytes.
74         Intended to speed up tools that read log messages from `git log`
75         output by allowing them to allocate space in advance.
76
77 -L <start>,<end>:<file>::
78 -L :<funcname>:<file>::
79         Trace the evolution of the line range given by "<start>,<end>"
80         (or the function name regex <funcname>) within the <file>.  You may
81         not give any pathspec limiters.  This is currently limited to
82         a walk starting from a single revision, i.e., you may only
83         give zero or one positive revision arguments, and
84         <start> and <end> (or <funcname>) must exist in the starting revision.
85         You can specify this option more than once. Implies `--patch`.
86         Patch output can be suppressed using `--no-patch`, but other diff formats
87         (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
88         `--name-only`, `--name-status`, `--check`) are not currently implemented.
89 +
90 include::line-range-format.txt[]
91
92 <revision range>::
93         Show only commits in the specified revision range.  When no
94         <revision range> is specified, it defaults to `HEAD` (i.e. the
95         whole history leading to the current commit).  `origin..HEAD`
96         specifies all the commits reachable from the current commit
97         (i.e. `HEAD`), but not from `origin`. For a complete list of
98         ways to spell <revision range>, see the 'Specifying Ranges'
99         section of linkgit:gitrevisions[7].
100
101 [--] <path>...::
102         Show only commits that are enough to explain how the files
103         that match the specified paths came to be.  See 'History
104         Simplification' below for details and other simplification
105         modes.
106 +
107 Paths may need to be prefixed with `--` to separate them from
108 options or the revision range, when confusion arises.
109
110 include::rev-list-options.txt[]
111
112 include::pretty-formats.txt[]
113
114 DIFF FORMATTING
115 ---------------
116
117 By default, `git log` does not generate any diff output. The options
118 below can be used to show the changes made by each commit.
119
120 -c::
121         With this option, diff output for a merge commit
122         shows the differences from each of the parents to the merge result
123         simultaneously instead of showing pairwise diff between a parent
124         and the result one at a time. Furthermore, it lists only files
125         which were modified from all parents.
126
127 --cc::
128         This flag implies the `-c` option and further compresses the
129         patch output by omitting uninteresting hunks whose contents in
130         the parents have only two variants and the merge result picks
131         one of them without modification.
132
133 --combined-all-paths::
134         This flag causes combined diffs (used for merge commits) to
135         list the name of the file from all parents.  It thus only has
136         effect when -c or --cc are specified, and is likely only
137         useful if filename changes are detected (i.e. when either
138         rename or copy detection have been requested).
139
140 -m::
141 --diff-merges::
142         This flag makes the merge commits show the full diff like
143         regular commits; for each merge parent, a separate log entry
144         and diff is generated. An exception is that only diff against
145         the first parent is shown when `--first-parent` option is given;
146         in that case, the output represents the changes the merge
147         brought _into_ the then-current branch.
148
149 :git-log: 1
150 include::diff-options.txt[]
151
152 include::diff-generate-patch.txt[]
153
154 EXAMPLES
155 --------
156 `git log --no-merges`::
157
158         Show the whole commit history, but skip any merges
159
160 `git log v2.6.12.. include/scsi drivers/scsi`::
161
162         Show all commits since version 'v2.6.12' that changed any file
163         in the `include/scsi` or `drivers/scsi` subdirectories
164
165 `git log --since="2 weeks ago" -- gitk`::
166
167         Show the changes during the last two weeks to the file 'gitk'.
168         The `--` is necessary to avoid confusion with the *branch* named
169         'gitk'
170
171 `git log --name-status release..test`::
172
173         Show the commits that are in the "test" branch but not yet
174         in the "release" branch, along with the list of paths
175         each commit modifies.
176
177 `git log --follow builtin/rev-list.c`::
178
179         Shows the commits that changed `builtin/rev-list.c`, including
180         those commits that occurred before the file was given its
181         present name.
182
183 `git log --branches --not --remotes=origin`::
184
185         Shows all commits that are in any of local branches but not in
186         any of remote-tracking branches for 'origin' (what you have that
187         origin doesn't).
188
189 `git log master --not --remotes=*/master`::
190
191         Shows all commits that are in local master but not in any remote
192         repository master branches.
193
194 `git log -p -m --first-parent`::
195
196         Shows the history including change diffs, but only from the
197         ``main branch'' perspective, skipping commits that come from merged
198         branches, and showing full diffs of changes introduced by the merges.
199         This makes sense only when following a strict policy of merging all
200         topic branches when staying on a single integration branch.
201
202 `git log -L '/int main/',/^}/:main.c`::
203
204         Shows how the function `main()` in the file `main.c` evolved
205         over time.
206
207 `git log -3`::
208
209         Limits the number of commits to show to 3.
210
211 DISCUSSION
212 ----------
213
214 include::i18n.txt[]
215
216 CONFIGURATION
217 -------------
218
219 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
220 for settings related to diff generation.
221
222 format.pretty::
223         Default for the `--format` option.  (See 'Pretty Formats' above.)
224         Defaults to `medium`.
225
226 i18n.logOutputEncoding::
227         Encoding to use when displaying logs.  (See 'Discussion' above.)
228         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
229         otherwise.
230
231 log.date::
232         Default format for human-readable dates.  (Compare the
233         `--date` option.)  Defaults to "default", which means to write
234         dates like `Sat May 8 19:35:34 2010 -0500`.
235 +
236 If the format is set to "auto:foo" and the pager is in use, format
237 "foo" will be the used for the date format. Otherwise "default" will
238 be used.
239
240 log.follow::
241         If `true`, `git log` will act as if the `--follow` option was used when
242         a single <path> is given.  This has the same limitations as `--follow`,
243         i.e. it cannot be used to follow multiple files and does not work well
244         on non-linear history.
245
246 log.showRoot::
247         If `false`, `git log` and related commands will not treat the
248         initial commit as a big creation event.  Any root commits in
249         `git log -p` output would be shown without a diff attached.
250         The default is `true`.
251
252 log.showSignature::
253         If `true`, `git log` and related commands will act as if the
254         `--show-signature` option was passed to them.
255
256 mailmap.*::
257         See linkgit:git-shortlog[1].
258
259 notes.displayRef::
260         Which refs, in addition to the default set by `core.notesRef`
261         or `GIT_NOTES_REF`, to read notes from when showing commit
262         messages with the `log` family of commands.  See
263         linkgit:git-notes[1].
264 +
265 May be an unabbreviated ref name or a glob and may be specified
266 multiple times.  A warning will be issued for refs that do not exist,
267 but a glob that does not match any refs is silently ignored.
268 +
269 This setting can be disabled by the `--no-notes` option,
270 overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
271 and overridden by the `--notes=<ref>` option.
272
273 GIT
274 ---
275 Part of the linkgit:git[1] suite