checkout_entry(): clarify the use of topath[] parameter
[git.git] / Documentation / git-log.txt
blobac2694d04cfc73c9b5ae6e6982d2f7f290ed67fe
1 git-log(1)
2 ==========
4 NAME
5 ----
6 git-log - Show commit logs
9 SYNOPSIS
10 --------
11 [verse]
12 'git log' [<options>] [<revision range>] [[\--] <path>...]
14 DESCRIPTION
15 -----------
16 Shows the commit logs.
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.
24 OPTIONS
25 -------
27 --follow::
28         Continue listing the history of a file beyond renames
29         (works only for a single file).
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'.
39 --source::
40         Print out the ref name given on the command line by which each
41         commit was reached.
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].
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.
55 Note that this affects all diff-based output types, e.g. those
56 produced by --stat etc.
58 --log-size::
59         Before the log message print out its size in bytes. Intended
60         mainly for porcelain tools consumption. If Git is unable to
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.
65 -L <start>,<end>:<file>, -L :<regex>:<file>::
67         Trace the evolution of the line range given by "<start>,<end>"
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.
72         You can specify this option more than once.
74 <start> and <end> can take one of these forms:
76 include::line-range-format.txt[]
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].
87 [\--] <path>...::
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.
93 Paths may need to be prefixed with "\-- " to separate them from
94 options or the revision range, when confusion arises.
96 include::rev-list-options.txt[]
98 include::pretty-formats.txt[]
100 COMMON DIFF OPTIONS
101 -------------------
103 :git-log: 1
104 include::diff-options.txt[]
106 include::diff-generate-patch.txt[]
108 EXAMPLES
109 --------
110 `git log --no-merges`::
112         Show the whole commit history, but skip any merges
114 `git log v2.6.12.. include/scsi drivers/scsi`::
116         Show all commits since version 'v2.6.12' that changed any file
117         in the include/scsi or drivers/scsi subdirectories
119 `git log --since="2 weeks ago" -- gitk`::
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'
125 `git log --name-status release..test`::
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.
131 `git log --follow builtin/rev-list.c`::
133         Shows the commits that changed builtin/rev-list.c, including
134         those commits that occurred before the file was given its
135         present name.
137 `git log --branches --not --remotes=origin`::
139         Shows all commits that are in any of local branches but not in
140         any of remote-tracking branches for 'origin' (what you have that
141         origin doesn't).
143 `git log master --not --remotes=*/master`::
145         Shows all commits that are in local master but not in any remote
146         repository master branches.
148 `git log -p -m --first-parent`::
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.
156 `git log -L '/int main/',/^}/:main.c`::
158         Shows how the function `main()` in the file 'main.c' evolved
159         over time.
161 `git log -3`::
162         Limits the number of commits to show to 3.
164 DISCUSSION
165 ----------
167 include::i18n.txt[]
169 CONFIGURATION
170 -------------
172 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
173 for settings related to diff generation.
175 format.pretty::
176         Default for the `--format` option.  (See "PRETTY FORMATS" above.)
177         Defaults to "medium".
179 i18n.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.
184 log.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`.
189 log.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`.
195 mailmap.*::
196         See linkgit:git-shortlog[1].
198 notes.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].
204 May be an unabbreviated ref name or a glob and may be specified
205 multiple times.  A warning will be issued for refs that do not exist,
206 but a glob that does not match any refs is silently ignored.
208 This setting can be disabled by the `--no-notes` option,
209 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
210 and overridden by the `--notes=<ref>` option.
214 Part of the linkgit:git[1] suite