Documentation/git-filter-branch: Move note about effect of removing commits
[git/mingw.git] / Documentation / git-log.txt
blob1f906208f9514180fe9f20293ab28ce8180b5357
1 git-log(1)
2 ==========
4 NAME
5 ----
6 git-log - Show commit logs
9 SYNOPSIS
10 --------
11 [verse]
12 'git log' [<options>] [<since>..<until>] [[\--] <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 -<n>::
28         Limits the number of commits to show.
29         Note that this is a commit limiting option, see below.
31 <since>..<until>::
32         Show only commits between the named two commits.  When
33         either <since> or <until> is omitted, it defaults to
34         `HEAD`, i.e. the tip of the current branch.
35         For a more complete list of ways to spell <since>
36         and <until>, see linkgit:gitrevisions[7].
38 --follow::
39         Continue listing the history of a file beyond renames
40         (works only for a single file).
42 --no-decorate::
43 --decorate[=short|full|no]::
44         Print out the ref names of any commits that are shown. If 'short' is
45         specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
46         'refs/remotes/' will not be printed. If 'full' is specified, the
47         full ref name (including prefix) will be printed. The default option
48         is 'short'.
50 --source::
51         Print out the ref name given on the command line by which each
52         commit was reached.
54 --full-diff::
55         Without this flag, "git log -p <path>..." shows commits that
56         touch the specified paths, and diffs about the same specified
57         paths.  With this, the full diff is shown for commits that touch
58         the specified paths; this means that "<path>..." limits only
59         commits, and doesn't limit diff for those commits.
61 Note that this affects all diff-based output types, e.g. those
62 produced by --stat etc.
64 --log-size::
65         Before the log message print out its size in bytes. Intended
66         mainly for porcelain tools consumption. If git is unable to
67         produce a valid value size is set to zero.
68         Note that only message is considered, if also a diff is shown
69         its size is not included.
71 [\--] <path>...::
72         Show only commits that are enough to explain how the files
73         that match the specified paths came to be.  See "History
74         Simplification" below for details and other simplification
75         modes.
77 To prevent confusion with options and branch names, paths may need to
78 be prefixed with "\-- " to separate them from options or refnames.
80 include::rev-list-options.txt[]
82 include::pretty-formats.txt[]
84 Common diff options
85 -------------------
87 :git-log: 1
88 include::diff-options.txt[]
90 include::diff-generate-patch.txt[]
92 Examples
93 --------
94 `git log --no-merges`::
96         Show the whole commit history, but skip any merges
98 `git log v2.6.12.. include/scsi drivers/scsi`::
100         Show all commits since version 'v2.6.12' that changed any file
101         in the include/scsi or drivers/scsi subdirectories
103 `git log --since="2 weeks ago" -- gitk`::
105         Show the changes during the last two weeks to the file 'gitk'.
106         The "--" is necessary to avoid confusion with the *branch* named
107         'gitk'
109 `git log --name-status release..test`::
111         Show the commits that are in the "test" branch but not yet
112         in the "release" branch, along with the list of paths
113         each commit modifies.
115 `git log --follow builtin-rev-list.c`::
117         Shows the commits that changed builtin-rev-list.c, including
118         those commits that occurred before the file was given its
119         present name.
121 `git log --branches --not --remotes=origin`::
123         Shows all commits that are in any of local branches but not in
124         any of remote-tracking branches for 'origin' (what you have that
125         origin doesn't).
127 `git log master --not --remotes=*/master`::
129         Shows all commits that are in local master but not in any remote
130         repository master branches.
132 `git log -p -m --first-parent`::
134         Shows the history including change diffs, but only from the
135         "main branch" perspective, skipping commits that come from merged
136         branches, and showing full diffs of changes introduced by the merges.
137         This makes sense only when following a strict policy of merging all
138         topic branches when staying on a single integration branch.
141 Discussion
142 ----------
144 include::i18n.txt[]
146 Configuration
147 -------------
149 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
150 for settings related to diff generation.
152 format.pretty::
153         Default for the `--format` option.  (See "PRETTY FORMATS" above.)
154         Defaults to "medium".
156 i18n.logOutputEncoding::
157         Encoding to use when displaying logs.  (See "Discussion", above.)
158         Defaults to the value of `i18n.commitEncoding` if set, UTF-8
159         otherwise.
161 log.date::
162         Default format for human-readable dates.  (Compare the
163         `--date` option.)  Defaults to "default", which means to write
164         dates like `Sat May 8 19:35:34 2010 -0500`.
166 log.showroot::
167         If `false`, 'git log' and related commands will not treat the
168         initial commit as a big creation event.  Any root commits in
169         `git log -p` output would be shown without a diff attached.
170         The default is `true`.
172 mailmap.file::
173         See linkgit:git-shortlog[1].
175 notes.displayRef::
176         Which refs, in addition to the default set by `core.notesRef`
177         or 'GIT_NOTES_REF', to read notes from when showing commit
178         messages with the 'log' family of commands.  See
179         linkgit:git-notes[1].
181 May be an unabbreviated ref name or a glob and may be specified
182 multiple times.  A warning will be issued for refs that do not exist,
183 but a glob that does not match any refs is silently ignored.
185 This setting can be disabled by the `--no-notes` option,
186 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
187 and overridden by the `--notes=<ref>` option.
191 Part of the linkgit:git[1] suite