Merge branch 'jx/atomic-push'
[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`.
47
48 --source::
49         Print out the ref name given on the command line by which each
50         commit was reached.
51
52 --[no-]mailmap::
53 --[no-]use-mailmap::
54         Use mailmap file to map author and committer names and email
55         addresses to canonical real names and email addresses. See
56         linkgit:git-shortlog[1].
57
58 --full-diff::
59         Without this flag, `git log -p <path>...` shows commits that
60         touch the specified paths, and diffs about the same specified
61         paths.  With this, the full diff is shown for commits that touch
62         the specified paths; this means that "<path>..." limits only
63         commits, and doesn't limit diff for those commits.
64 +
65 Note that this affects all diff-based output types, e.g. those
66 produced by `--stat`, etc.
67
68 --log-size::
69         Include a line ``log size <number>'' in the output for each commit,
70         where <number> is the length of that commit's message in bytes.
71         Intended to speed up tools that read log messages from `git log`
72         output by allowing them to allocate space in advance.
73
74 -L <start>,<end>:<file>::
75 -L :<funcname>:<file>::
76         Trace the evolution of the line range given by "<start>,<end>"
77         (or the function name regex <funcname>) within the <file>.  You may
78         not give any pathspec limiters.  This is currently limited to
79         a walk starting from a single revision, i.e., you may only
80         give zero or one positive revision arguments, and
81         <start> and <end> (or <funcname>) must exist in the starting revision.
82         You can specify this option more than once. Implies `--patch`.
83         Patch output can be suppressed using `--no-patch`, but other diff formats
84         (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
85         `--name-only`, `--name-status`, `--check`) are not currently implemented.
86 +
87 include::line-range-format.txt[]
88
89 <revision range>::
90         Show only commits in the specified revision range.  When no
91         <revision range> is specified, it defaults to `HEAD` (i.e. the
92         whole history leading to the current commit).  `origin..HEAD`
93         specifies all the commits reachable from the current commit
94         (i.e. `HEAD`), but not from `origin`. For a complete list of
95         ways to spell <revision range>, see the 'Specifying Ranges'
96         section of linkgit:gitrevisions[7].
97
98 [--] <path>...::
99         Show only commits that are enough to explain how the files
100         that match the specified paths came to be.  See 'History
101         Simplification' below for details and other simplification
102         modes.
103 +
104 Paths may need to be prefixed with `--` to separate them from
105 options or the revision range, when confusion arises.
106
107 include::rev-list-options.txt[]
108
109 include::pretty-formats.txt[]
110
111 COMMON DIFF OPTIONS
112 -------------------
113
114 :git-log: 1
115 include::diff-options.txt[]
116
117 include::diff-generate-patch.txt[]
118
119 EXAMPLES
120 --------
121 `git log --no-merges`::
122
123         Show the whole commit history, but skip any merges
124
125 `git log v2.6.12.. include/scsi drivers/scsi`::
126
127         Show all commits since version 'v2.6.12' that changed any file
128         in the `include/scsi` or `drivers/scsi` subdirectories
129
130 `git log --since="2 weeks ago" -- gitk`::
131
132         Show the changes during the last two weeks to the file 'gitk'.
133         The `--` is necessary to avoid confusion with the *branch* named
134         'gitk'
135
136 `git log --name-status release..test`::
137
138         Show the commits that are in the "test" branch but not yet
139         in the "release" branch, along with the list of paths
140         each commit modifies.
141
142 `git log --follow builtin/rev-list.c`::
143
144         Shows the commits that changed `builtin/rev-list.c`, including
145         those commits that occurred before the file was given its
146         present name.
147
148 `git log --branches --not --remotes=origin`::
149
150         Shows all commits that are in any of local branches but not in
151         any of remote-tracking branches for 'origin' (what you have that
152         origin doesn't).
153
154 `git log master --not --remotes=*/master`::
155
156         Shows all commits that are in local master but not in any remote
157         repository master branches.
158
159 `git log -p -m --first-parent`::
160
161         Shows the history including change diffs, but only from the
162         ``main branch'' perspective, skipping commits that come from merged
163         branches, and showing full diffs of changes introduced by the merges.
164         This makes sense only when following a strict policy of merging all
165         topic branches when staying on a single integration branch.
166
167 `git log -L '/int main/',/^}/:main.c`::
168
169         Shows how the function `main()` in the file `main.c` evolved
170         over time.
171
172 `git log -3`::
173
174         Limits the number of commits to show to 3.
175
176 DISCUSSION
177 ----------
178
179 include::i18n.txt[]
180
181 CONFIGURATION
182 -------------
183
184 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
185 for settings related to diff generation.
186
187 format.pretty::
188         Default for the `--format` option.  (See 'Pretty Formats' above.)
189         Defaults to `medium`.
190
191 i18n.logOutputEncoding::
192         Encoding to use when displaying logs.  (See 'Discussion' above.)
193         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
194         otherwise.
195
196 log.date::
197         Default format for human-readable dates.  (Compare the
198         `--date` option.)  Defaults to "default", which means to write
199         dates like `Sat May 8 19:35:34 2010 -0500`.
200 +
201 If the format is set to "auto:foo" and the pager is in use, format
202 "foo" will be the used for the date format. Otherwise "default" will
203 be used.
204
205 log.follow::
206         If `true`, `git log` will act as if the `--follow` option was used when
207         a single <path> is given.  This has the same limitations as `--follow`,
208         i.e. it cannot be used to follow multiple files and does not work well
209         on non-linear history.
210
211 log.showRoot::
212         If `false`, `git log` and related commands will not treat the
213         initial commit as a big creation event.  Any root commits in
214         `git log -p` output would be shown without a diff attached.
215         The default is `true`.
216
217 log.showSignature::
218         If `true`, `git log` and related commands will act as if the
219         `--show-signature` option was passed to them.
220
221 mailmap.*::
222         See linkgit:git-shortlog[1].
223
224 notes.displayRef::
225         Which refs, in addition to the default set by `core.notesRef`
226         or `GIT_NOTES_REF`, to read notes from when showing commit
227         messages with the `log` family of commands.  See
228         linkgit:git-notes[1].
229 +
230 May be an unabbreviated ref name or a glob and may be specified
231 multiple times.  A warning will be issued for refs that do not exist,
232 but a glob that does not match any refs is silently ignored.
233 +
234 This setting can be disabled by the `--no-notes` option,
235 overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
236 and overridden by the `--notes=<ref>` option.
237
238 GIT
239 ---
240 Part of the linkgit:git[1] suite