Post 2.3 cycle (batch #9)
[git/git.git] / Documentation / git-log.txt
CommitLineData
215a7ad1
JH
1git-log(1)
2==========
3f971fc4
JH
3
4NAME
5----
215a7ad1 6git-log - Show commit logs
3f971fc4
JH
7
8
9SYNOPSIS
10--------
7791a1d9 11[verse]
21a40b90 12'git log' [<options>] [<revision range>] [[\--] <path>...]
3f971fc4
JH
13
14DESCRIPTION
15-----------
e51c3b50
JH
16Shows the commit logs.
17
b20cc13e 18The command takes options applicable to the `git rev-list`
e51c3b50 19command to control what is shown and how, and options applicable to
b20cc13e 20the `git diff-*` commands to control how the changes
e51c3b50
JH
21each commit introduces are shown.
22
3f971fc4
JH
23
24OPTIONS
25-------
5d1faf87 26
4ded6916
EB
27--follow::
28 Continue listing the history of a file beyond renames
29 (works only for a single file).
30
8a3d203b
JH
31--no-decorate::
32--decorate[=short|full|no]::
33e7018c
LH
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. The default option
37 is 'short'.
56822cc9 38
30c4d7a7
NS
39--source::
40 Print out the ref name given on the command line by which each
41 commit was reached.
42
ea57bc0d
AP
43--use-mailmap::
44 Use mailmap file to map author and committer names and email
b20cc13e 45 addresses to canonical real names and email addresses. See
ea57bc0d
AP
46 linkgit:git-shortlog[1].
47
2e88c266 48--full-diff::
b20cc13e 49 Without this flag, `git log -p <path>...` shows commits that
2e88c266
JN
50 touch the specified paths, and diffs about the same specified
51 paths. With this, the full diff is shown for commits that touch
f448e24e 52 the specified paths; this means that "<path>..." limits only
2e88c266 53 commits, and doesn't limit diff for those commits.
b1c7946d
MG
54+
55Note that this affects all diff-based output types, e.g. those
b20cc13e 56produced by `--stat`, etc.
2e88c266 57
9fa3465d 58--log-size::
c20e6fb1
JSJ
59 Include a line ``log size <number>'' in the output for each commit,
60 where <number> is the length of that commit's message in bytes.
61 Intended to speed up tools that read log messages from `git log`
62 output by allowing them to allocate space in advance.
9fa3465d 63
1e159833
ES
64-L <start>,<end>:<file>::
65-L :<regex>:<file>::
12da1d1f 66 Trace the evolution of the line range given by "<start>,<end>"
13b8f68c
TR
67 (or the funcname regex <regex>) within the <file>. You may
68 not give any pathspec limiters. This is currently limited to
69 a walk starting from a single revision, i.e., you may only
70 give zero or one positive revision arguments.
0f483436
JH
71 You can specify this option more than once.
72+
12da1d1f 73include::line-range-format.txt[]
12da1d1f 74
21a40b90
RR
75<revision range>::
76 Show only commits in the specified revision range. When no
77 <revision range> is specified, it defaults to `HEAD` (i.e. the
78 whole history leading to the current commit). `origin..HEAD`
79 specifies all the commits reachable from the current commit
80 (i.e. `HEAD`), but not from `origin`. For a complete list of
b20cc13e 81 ways to spell <revision range>, see the 'Specifying Ranges'
21a40b90 82 section of linkgit:gitrevisions[7].
a682187e 83
b1524ee0 84[\--] <path>...::
b15b5b10 85 Show only commits that are enough to explain how the files
b20cc13e
JSJ
86 that match the specified paths came to be. See 'History
87 Simplification' below for details and other simplification
b15b5b10
TR
88 modes.
89+
b20cc13e 90Paths may need to be prefixed with ``\-- '' to separate them from
00200e9e 91options or the revision range, when confusion arises.
e51c3b50 92
f98fd436
MG
93include::rev-list-options.txt[]
94
95include::pretty-formats.txt[]
96
4ba258b7 97COMMON DIFF OPTIONS
f98fd436 98-------------------
4ded6916
EB
99
100:git-log: 1
101include::diff-options.txt[]
331b51d2 102
272bd3cf 103include::diff-generate-patch.txt[]
331b51d2 104
4ba258b7 105EXAMPLES
bd663611 106--------
5d2fc913 107`git log --no-merges`::
bd663611
LT
108
109 Show the whole commit history, but skip any merges
110
5d2fc913 111`git log v2.6.12.. include/scsi drivers/scsi`::
bd663611
LT
112
113 Show all commits since version 'v2.6.12' that changed any file
b20cc13e 114 in the `include/scsi` or `drivers/scsi` subdirectories
bd663611 115
6cf378f0 116`git log --since="2 weeks ago" -- gitk`::
bd663611
LT
117
118 Show the changes during the last two weeks to the file 'gitk'.
b20cc13e 119 The ``--'' is necessary to avoid confusion with the *branch* named
bd663611
LT
120 'gitk'
121
5d2fc913 122`git log --name-status release..test`::
e51c3b50
JH
123
124 Show the commits that are in the "test" branch but not yet
125 in the "release" branch, along with the list of paths
126 each commit modifies.
bd663611 127
09b7e220 128`git log --follow builtin/rev-list.c`::
4f50f6a9 129
b20cc13e 130 Shows the commits that changed `builtin/rev-list.c`, including
4f50f6a9
SW
131 those commits that occurred before the file was given its
132 present name.
133
5d2fc913 134`git log --branches --not --remotes=origin`::
d08bae7e
IL
135
136 Shows all commits that are in any of local branches but not in
0e615b25 137 any of remote-tracking branches for 'origin' (what you have that
d08bae7e
IL
138 origin doesn't).
139
5d2fc913 140`git log master --not --remotes=*/master`::
d08bae7e
IL
141
142 Shows all commits that are in local master but not in any remote
143 repository master branches.
144
5d2fc913 145`git log -p -m --first-parent`::
88d9d45d
PB
146
147 Shows the history including change diffs, but only from the
b20cc13e 148 ``main branch'' perspective, skipping commits that come from merged
88d9d45d
PB
149 branches, and showing full diffs of changes introduced by the merges.
150 This makes sense only when following a strict policy of merging all
151 topic branches when staying on a single integration branch.
152
001b0976 153`git log -L '/int main/',/^}/:main.c`::
12da1d1f 154
b20cc13e 155 Shows how the function `main()` in the file `main.c` evolved
12da1d1f
TR
156 over time.
157
70c2a258 158`git log -3`::
b20cc13e 159
70c2a258 160 Limits the number of commits to show to 3.
88d9d45d 161
4ba258b7 162DISCUSSION
5dc7bcc2
JH
163----------
164
165include::i18n.txt[]
166
4ba258b7 167CONFIGURATION
59893a88
JN
168-------------
169
170See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
171for settings related to diff generation.
172
173format.pretty::
b20cc13e
JSJ
174 Default for the `--format` option. (See 'Pretty Formats' above.)
175 Defaults to `medium`.
59893a88
JN
176
177i18n.logOutputEncoding::
b20cc13e
JSJ
178 Encoding to use when displaying logs. (See 'Discussion' above.)
179 Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
59893a88
JN
180 otherwise.
181
182log.date::
183 Default format for human-readable dates. (Compare the
184 `--date` option.) Defaults to "default", which means to write
185 dates like `Sat May 8 19:35:34 2010 -0500`.
186
187log.showroot::
b20cc13e 188 If `false`, `git log` and related commands will not treat the
59893a88
JN
189 initial commit as a big creation event. Any root commits in
190 `git log -p` output would be shown without a diff attached.
191 The default is `true`.
192
d5422b0c 193mailmap.*::
59893a88
JN
194 See linkgit:git-shortlog[1].
195
196notes.displayRef::
197 Which refs, in addition to the default set by `core.notesRef`
198 or 'GIT_NOTES_REF', to read notes from when showing commit
b20cc13e 199 messages with the `log` family of commands. See
59893a88
JN
200 linkgit:git-notes[1].
201+
202May be an unabbreviated ref name or a glob and may be specified
203multiple times. A warning will be issued for refs that do not exist,
204but a glob that does not match any refs is silently ignored.
205+
ab18b2c0 206This setting can be disabled by the `--no-notes` option,
59893a88 207overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
ab18b2c0 208and overridden by the `--notes=<ref>` option.
5dc7bcc2 209
3f971fc4
JH
210GIT
211---
9e1f0a85 212Part of the linkgit:git[1] suite