Implement line-history search (git log -L)
[git/git.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>] [<since>..<until>] [[\--] <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 <since>..<until>::
28 Show only commits between the named two commits. When
29 either <since> or <until> is omitted, it defaults to
30 `HEAD`, i.e. the tip of the current branch.
31 For a more complete list of ways to spell <since>
32 and <until>, see linkgit:gitrevisions[7].
33
34 --follow::
35 Continue listing the history of a file beyond renames
36 (works only for a single file).
37
38 --no-decorate::
39 --decorate[=short|full|no]::
40 Print out the ref names of any commits that are shown. If 'short' is
41 specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
42 'refs/remotes/' will not be printed. If 'full' is specified, the
43 full ref name (including prefix) will be printed. The default option
44 is 'short'.
45
46 --source::
47 Print out the ref name given on the command line by which each
48 commit was reached.
49
50 --use-mailmap::
51 Use mailmap file to map author and committer names and email
52 to canonical real names and email addresses. See
53 linkgit:git-shortlog[1].
54
55 --full-diff::
56 Without this flag, "git log -p <path>..." shows commits that
57 touch the specified paths, and diffs about the same specified
58 paths. With this, the full diff is shown for commits that touch
59 the specified paths; this means that "<path>..." limits only
60 commits, and doesn't limit diff for those commits.
61 +
62 Note that this affects all diff-based output types, e.g. those
63 produced by --stat etc.
64
65 --log-size::
66 Before the log message print out its size in bytes. Intended
67 mainly for porcelain tools consumption. If Git is unable to
68 produce a valid value size is set to zero.
69 Note that only message is considered, if also a diff is shown
70 its size is not included.
71
72 -L <start>,<end>:<file>::
73 Trace the evolution of the line range given by "<start>,<end>"
74 within the <file>. You may not give any pathspec limiters.
75 This is currently limited to a walk starting from a single
76 revision, i.e., you may only give zero or one positive
77 revision arguments.
78
79 <start> and <end> can take one of these forms:
80
81 include::line-range-format.txt[]
82 You can specify this option more than once.
83
84
85 --full-line-diff::
86 Always print the interesting range even if the current commit
87 does not change any line of the range.
88
89 [\--] <path>...::
90 Show only commits that are enough to explain how the files
91 that match the specified paths came to be. See "History
92 Simplification" below for details and other simplification
93 modes.
94 +
95 To prevent confusion with options and branch names, paths may need to
96 be prefixed with "\-- " to separate them from options or refnames.
97
98 include::rev-list-options.txt[]
99
100 include::pretty-formats.txt[]
101
102 Common diff options
103 -------------------
104
105 :git-log: 1
106 include::diff-options.txt[]
107
108 include::diff-generate-patch.txt[]
109
110 Examples
111 --------
112 `git log --no-merges`::
113
114 Show the whole commit history, but skip any merges
115
116 `git log v2.6.12.. include/scsi drivers/scsi`::
117
118 Show all commits since version 'v2.6.12' that changed any file
119 in the include/scsi or drivers/scsi subdirectories
120
121 `git log --since="2 weeks ago" -- gitk`::
122
123 Show the changes during the last two weeks to the file 'gitk'.
124 The "--" is necessary to avoid confusion with the *branch* named
125 'gitk'
126
127 `git log --name-status release..test`::
128
129 Show the commits that are in the "test" branch but not yet
130 in the "release" branch, along with the list of paths
131 each commit modifies.
132
133 `git log --follow builtin-rev-list.c`::
134
135 Shows the commits that changed builtin-rev-list.c, including
136 those commits that occurred before the file was given its
137 present name.
138
139 `git log --branches --not --remotes=origin`::
140
141 Shows all commits that are in any of local branches but not in
142 any of remote-tracking branches for 'origin' (what you have that
143 origin doesn't).
144
145 `git log master --not --remotes=*/master`::
146
147 Shows all commits that are in local master but not in any remote
148 repository master branches.
149
150 `git log -p -m --first-parent`::
151
152 Shows the history including change diffs, but only from the
153 "main branch" perspective, skipping commits that come from merged
154 branches, and showing full diffs of changes introduced by the merges.
155 This makes sense only when following a strict policy of merging all
156 topic branches when staying on a single integration branch.
157
158 git log -L '/int main/',/^}/:main.c::
159
160 Shows how the function `main()` in the file 'main.c' evolved
161 over time.
162
163 `git log -3`::
164 Limits the number of commits to show to 3.
165
166 Discussion
167 ----------
168
169 include::i18n.txt[]
170
171 Configuration
172 -------------
173
174 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
175 for settings related to diff generation.
176
177 format.pretty::
178 Default for the `--format` option. (See "PRETTY FORMATS" above.)
179 Defaults to "medium".
180
181 i18n.logOutputEncoding::
182 Encoding to use when displaying logs. (See "Discussion", above.)
183 Defaults to the value of `i18n.commitEncoding` if set, UTF-8
184 otherwise.
185
186 log.date::
187 Default format for human-readable dates. (Compare the
188 `--date` option.) Defaults to "default", which means to write
189 dates like `Sat May 8 19:35:34 2010 -0500`.
190
191 log.showroot::
192 If `false`, 'git log' and related commands will not treat the
193 initial commit as a big creation event. Any root commits in
194 `git log -p` output would be shown without a diff attached.
195 The default is `true`.
196
197 mailmap.*::
198 See linkgit:git-shortlog[1].
199
200 notes.displayRef::
201 Which refs, in addition to the default set by `core.notesRef`
202 or 'GIT_NOTES_REF', to read notes from when showing commit
203 messages with the 'log' family of commands. See
204 linkgit:git-notes[1].
205 +
206 May be an unabbreviated ref name or a glob and may be specified
207 multiple times. A warning will be issued for refs that do not exist,
208 but a glob that does not match any refs is silently ignored.
209 +
210 This setting can be disabled by the `--no-notes` option,
211 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
212 and overridden by the `--notes=<ref>` option.
213
214 GIT
215 ---
216 Part of the linkgit:git[1] suite