Documentation: move description of -s, --no-patch to diff-options.txt
[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
MC
58--log-size::
59 Before the log message print out its size in bytes. Intended
2de9b711 60 mainly for porcelain tools consumption. If Git is unable to
9fa3465d
MC
61 produce a valid value size is set to zero.
62 Note that only message is considered, if also a diff is shown
63 its size is not included.
64
21a40b90
RR
65<revision range>::
66 Show only commits in the specified revision range. When no
67 <revision range> is specified, it defaults to `HEAD` (i.e. the
68 whole history leading to the current commit). `origin..HEAD`
69 specifies all the commits reachable from the current commit
70 (i.e. `HEAD`), but not from `origin`. For a complete list of
71 ways to spell <revision range>, see the "Specifying Ranges"
72 section of linkgit:gitrevisions[7].
a682187e 73
b1524ee0 74[\--] <path>...::
b15b5b10
TR
75 Show only commits that are enough to explain how the files
76 that match the specified paths came to be. See "History
77 Simplification" below for details and other simplification
78 modes.
79+
00200e9e
RR
80Paths may need to be prefixed with "\-- " to separate them from
81options or the revision range, when confusion arises.
e51c3b50 82
f98fd436
MG
83include::rev-list-options.txt[]
84
85include::pretty-formats.txt[]
86
4ded6916 87Common diff options
f98fd436 88-------------------
4ded6916
EB
89
90:git-log: 1
91include::diff-options.txt[]
331b51d2 92
272bd3cf 93include::diff-generate-patch.txt[]
331b51d2 94
bd663611
LT
95Examples
96--------
5d2fc913 97`git log --no-merges`::
bd663611
LT
98
99 Show the whole commit history, but skip any merges
100
5d2fc913 101`git log v2.6.12.. include/scsi drivers/scsi`::
bd663611
LT
102
103 Show all commits since version 'v2.6.12' that changed any file
104 in the include/scsi or drivers/scsi subdirectories
105
6cf378f0 106`git log --since="2 weeks ago" -- gitk`::
bd663611
LT
107
108 Show the changes during the last two weeks to the file 'gitk'.
109 The "--" is necessary to avoid confusion with the *branch* named
110 'gitk'
111
5d2fc913 112`git log --name-status release..test`::
e51c3b50
JH
113
114 Show the commits that are in the "test" branch but not yet
115 in the "release" branch, along with the list of paths
116 each commit modifies.
bd663611 117
5d2fc913 118`git log --follow builtin-rev-list.c`::
4f50f6a9
SW
119
120 Shows the commits that changed builtin-rev-list.c, including
121 those commits that occurred before the file was given its
122 present name.
123
5d2fc913 124`git log --branches --not --remotes=origin`::
d08bae7e
IL
125
126 Shows all commits that are in any of local branches but not in
0e615b25 127 any of remote-tracking branches for 'origin' (what you have that
d08bae7e
IL
128 origin doesn't).
129
5d2fc913 130`git log master --not --remotes=*/master`::
d08bae7e
IL
131
132 Shows all commits that are in local master but not in any remote
133 repository master branches.
134
5d2fc913 135`git log -p -m --first-parent`::
88d9d45d
PB
136
137 Shows the history including change diffs, but only from the
138 "main branch" perspective, skipping commits that come from merged
139 branches, and showing full diffs of changes introduced by the merges.
140 This makes sense only when following a strict policy of merging all
141 topic branches when staying on a single integration branch.
142
70c2a258
NTND
143`git log -3`::
144 Limits the number of commits to show to 3.
88d9d45d 145
5dc7bcc2
JH
146Discussion
147----------
148
149include::i18n.txt[]
150
59893a88
JN
151Configuration
152-------------
153
154See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
155for settings related to diff generation.
156
157format.pretty::
158 Default for the `--format` option. (See "PRETTY FORMATS" above.)
159 Defaults to "medium".
160
161i18n.logOutputEncoding::
162 Encoding to use when displaying logs. (See "Discussion", above.)
163 Defaults to the value of `i18n.commitEncoding` if set, UTF-8
164 otherwise.
165
166log.date::
167 Default format for human-readable dates. (Compare the
168 `--date` option.) Defaults to "default", which means to write
169 dates like `Sat May 8 19:35:34 2010 -0500`.
170
171log.showroot::
172 If `false`, 'git log' and related commands will not treat the
173 initial commit as a big creation event. Any root commits in
174 `git log -p` output would be shown without a diff attached.
175 The default is `true`.
176
d5422b0c 177mailmap.*::
59893a88
JN
178 See linkgit:git-shortlog[1].
179
180notes.displayRef::
181 Which refs, in addition to the default set by `core.notesRef`
182 or 'GIT_NOTES_REF', to read notes from when showing commit
183 messages with the 'log' family of commands. See
184 linkgit:git-notes[1].
185+
186May be an unabbreviated ref name or a glob and may be specified
187multiple times. A warning will be issued for refs that do not exist,
188but a glob that does not match any refs is silently ignored.
189+
ab18b2c0 190This setting can be disabled by the `--no-notes` option,
59893a88 191overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
ab18b2c0 192and overridden by the `--notes=<ref>` option.
5dc7bcc2 193
3f971fc4
JH
194GIT
195---
9e1f0a85 196Part of the linkgit:git[1] suite