Merge branch 'nd/fixup-linked-gitdir'
[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|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. The default option
37         is 'short'.
38
39 --source::
40         Print out the ref name given on the command line by which each
41         commit was reached.
42
43 --use-mailmap::
44         Use mailmap file to map author and committer names and email
45         addresses to canonical real names and email addresses. See
46         linkgit:git-shortlog[1].
47
48 --full-diff::
49         Without this flag, `git log -p <path>...` shows commits that
50         touch the specified paths, and diffs about the same specified
51         paths.  With this, the full diff is shown for commits that touch
52         the specified paths; this means that "<path>..." limits only
53         commits, and doesn't limit diff for those commits.
54 +
55 Note that this affects all diff-based output types, e.g. those
56 produced by `--stat`, etc.
57
58 --log-size::
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.
63
64 -L <start>,<end>:<file>::
65 -L :<funcname>:<file>::
66         Trace the evolution of the line range given by "<start>,<end>"
67         (or the function name regex <funcname>) 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.
71         You can specify this option more than once.
72 +
73 include::line-range-format.txt[]
74
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
81         ways to spell <revision range>, see the 'Specifying Ranges'
82         section of linkgit:gitrevisions[7].
83
84 [\--] <path>...::
85         Show only commits that are enough to explain how the files
86         that match the specified paths came to be.  See 'History
87         Simplification' below for details and other simplification
88         modes.
89 +
90 Paths may need to be prefixed with ``\-- '' to separate them from
91 options or the revision range, when confusion arises.
92
93 include::rev-list-options.txt[]
94
95 include::pretty-formats.txt[]
96
97 COMMON DIFF OPTIONS
98 -------------------
99
100 :git-log: 1
101 include::diff-options.txt[]
102
103 include::diff-generate-patch.txt[]
104
105 EXAMPLES
106 --------
107 `git log --no-merges`::
108
109         Show the whole commit history, but skip any merges
110
111 `git log v2.6.12.. include/scsi drivers/scsi`::
112
113         Show all commits since version 'v2.6.12' that changed any file
114         in the `include/scsi` or `drivers/scsi` subdirectories
115
116 `git log --since="2 weeks ago" -- gitk`::
117
118         Show the changes during the last two weeks to the file 'gitk'.
119         The ``--'' is necessary to avoid confusion with the *branch* named
120         'gitk'
121
122 `git log --name-status release..test`::
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.
127
128 `git log --follow builtin/rev-list.c`::
129
130         Shows the commits that changed `builtin/rev-list.c`, including
131         those commits that occurred before the file was given its
132         present name.
133
134 `git log --branches --not --remotes=origin`::
135
136         Shows all commits that are in any of local branches but not in
137         any of remote-tracking branches for 'origin' (what you have that
138         origin doesn't).
139
140 `git log master --not --remotes=*/master`::
141
142         Shows all commits that are in local master but not in any remote
143         repository master branches.
144
145 `git log -p -m --first-parent`::
146
147         Shows the history including change diffs, but only from the
148         ``main branch'' perspective, skipping commits that come from merged
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
153 `git log -L '/int main/',/^}/:main.c`::
154
155         Shows how the function `main()` in the file `main.c` evolved
156         over time.
157
158 `git log -3`::
159
160         Limits the number of commits to show to 3.
161
162 DISCUSSION
163 ----------
164
165 include::i18n.txt[]
166
167 CONFIGURATION
168 -------------
169
170 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
171 for settings related to diff generation.
172
173 format.pretty::
174         Default for the `--format` option.  (See 'Pretty Formats' above.)
175         Defaults to `medium`.
176
177 i18n.logOutputEncoding::
178         Encoding to use when displaying logs.  (See 'Discussion' above.)
179         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
180         otherwise.
181
182 log.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
187 log.follow::
188         If a single <path> is given to git log, it will act as
189         if the `--follow` option was also used.  This has the same
190         limitations as `--follow`, i.e. it cannot be used to follow
191         multiple files and does not work well on non-linear history.
192
193 log.showRoot::
194         If `false`, `git log` and related commands will not treat the
195         initial commit as a big creation event.  Any root commits in
196         `git log -p` output would be shown without a diff attached.
197         The default is `true`.
198
199 mailmap.*::
200         See linkgit:git-shortlog[1].
201
202 notes.displayRef::
203         Which refs, in addition to the default set by `core.notesRef`
204         or 'GIT_NOTES_REF', to read notes from when showing commit
205         messages with the `log` family of commands.  See
206         linkgit:git-notes[1].
207 +
208 May be an unabbreviated ref name or a glob and may be specified
209 multiple times.  A warning will be issued for refs that do not exist,
210 but a glob that does not match any refs is silently ignored.
211 +
212 This setting can be disabled by the `--no-notes` option,
213 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
214 and overridden by the `--notes=<ref>` option.
215
216 GIT
217 ---
218 Part of the linkgit:git[1] suite