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