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