rev-parse --parseopt: add the --stuck-long mode
[git.git] / Documentation / git-log.txt
blob34097efea707aa59b6a5703826445f5c3fccabcf
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>::
66 -L :<regex>:<file>::
68         Trace the evolution of the line range given by "<start>,<end>"
69         (or the funcname regex <regex>) within the <file>.  You may
70         not give any pathspec limiters.  This is currently limited to
71         a walk starting from a single revision, i.e., you may only
72         give zero or one positive revision arguments.
73         You can specify this option more than once.
75 include::line-range-format.txt[]
77 <revision range>::
78         Show only commits in the specified revision range.  When no
79         <revision range> is specified, it defaults to `HEAD` (i.e. the
80         whole history leading to the current commit).  `origin..HEAD`
81         specifies all the commits reachable from the current commit
82         (i.e. `HEAD`), but not from `origin`. For a complete list of
83         ways to spell <revision range>, see the "Specifying Ranges"
84         section of linkgit:gitrevisions[7].
86 [\--] <path>...::
87         Show only commits that are enough to explain how the files
88         that match the specified paths came to be.  See "History
89         Simplification" below for details and other simplification
90         modes.
92 Paths may need to be prefixed with "\-- " to separate them from
93 options or the revision range, when confusion arises.
95 include::rev-list-options.txt[]
97 include::pretty-formats.txt[]
99 COMMON DIFF OPTIONS
100 -------------------
102 :git-log: 1
103 include::diff-options.txt[]
105 include::diff-generate-patch.txt[]
107 EXAMPLES
108 --------
109 `git log --no-merges`::
111         Show the whole commit history, but skip any merges
113 `git log v2.6.12.. include/scsi drivers/scsi`::
115         Show all commits since version 'v2.6.12' that changed any file
116         in the include/scsi or drivers/scsi subdirectories
118 `git log --since="2 weeks ago" -- gitk`::
120         Show the changes during the last two weeks to the file 'gitk'.
121         The "--" is necessary to avoid confusion with the *branch* named
122         'gitk'
124 `git log --name-status release..test`::
126         Show the commits that are in the "test" branch but not yet
127         in the "release" branch, along with the list of paths
128         each commit modifies.
130 `git log --follow builtin/rev-list.c`::
132         Shows the commits that changed builtin/rev-list.c, including
133         those commits that occurred before the file was given its
134         present name.
136 `git log --branches --not --remotes=origin`::
138         Shows all commits that are in any of local branches but not in
139         any of remote-tracking branches for 'origin' (what you have that
140         origin doesn't).
142 `git log master --not --remotes=*/master`::
144         Shows all commits that are in local master but not in any remote
145         repository master branches.
147 `git log -p -m --first-parent`::
149         Shows the history including change diffs, but only from the
150         "main branch" perspective, skipping commits that come from merged
151         branches, and showing full diffs of changes introduced by the merges.
152         This makes sense only when following a strict policy of merging all
153         topic branches when staying on a single integration branch.
155 `git log -L '/int main/',/^}/:main.c`::
157         Shows how the function `main()` in the file 'main.c' evolved
158         over time.
160 `git log -3`::
161         Limits the number of commits to show to 3.
163 DISCUSSION
164 ----------
166 include::i18n.txt[]
168 CONFIGURATION
169 -------------
171 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
172 for settings related to diff generation.
174 format.pretty::
175         Default for the `--format` option.  (See "PRETTY FORMATS" above.)
176         Defaults to "medium".
178 i18n.logOutputEncoding::
179         Encoding to use when displaying logs.  (See "Discussion", above.)
180         Defaults to the value of `i18n.commitEncoding` if set, UTF-8
181         otherwise.
183 log.date::
184         Default format for human-readable dates.  (Compare the
185         `--date` option.)  Defaults to "default", which means to write
186         dates like `Sat May 8 19:35:34 2010 -0500`.
188 log.showroot::
189         If `false`, 'git log' and related commands will not treat the
190         initial commit as a big creation event.  Any root commits in
191         `git log -p` output would be shown without a diff attached.
192         The default is `true`.
194 mailmap.*::
195         See linkgit:git-shortlog[1].
197 notes.displayRef::
198         Which refs, in addition to the default set by `core.notesRef`
199         or 'GIT_NOTES_REF', to read notes from when showing commit
200         messages with the 'log' family of commands.  See
201         linkgit:git-notes[1].
203 May be an unabbreviated ref name or a glob and may be specified
204 multiple times.  A warning will be issued for refs that do not exist,
205 but a glob that does not match any refs is silently ignored.
207 This setting can be disabled by the `--no-notes` option,
208 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
209 and overridden by the `--notes=<ref>` option.
213 Part of the linkgit:git[1] suite