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