git-log.txt: place each -L option variation on its own line
[alt-git.git] / Documentation / git-log.txt
blobfe04e06acba1a428698faf98dd8033cee304aeb2
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 <start> and <end> can take one of these forms:
77 include::line-range-format.txt[]
79 <revision range>::
80         Show only commits in the specified revision range.  When no
81         <revision range> is specified, it defaults to `HEAD` (i.e. the
82         whole history leading to the current commit).  `origin..HEAD`
83         specifies all the commits reachable from the current commit
84         (i.e. `HEAD`), but not from `origin`. For a complete list of
85         ways to spell <revision range>, see the "Specifying Ranges"
86         section of linkgit:gitrevisions[7].
88 [\--] <path>...::
89         Show only commits that are enough to explain how the files
90         that match the specified paths came to be.  See "History
91         Simplification" below for details and other simplification
92         modes.
94 Paths may need to be prefixed with "\-- " to separate them from
95 options or the revision range, when confusion arises.
97 include::rev-list-options.txt[]
99 include::pretty-formats.txt[]
101 COMMON DIFF OPTIONS
102 -------------------
104 :git-log: 1
105 include::diff-options.txt[]
107 include::diff-generate-patch.txt[]
109 EXAMPLES
110 --------
111 `git log --no-merges`::
113         Show the whole commit history, but skip any merges
115 `git log v2.6.12.. include/scsi drivers/scsi`::
117         Show all commits since version 'v2.6.12' that changed any file
118         in the include/scsi or drivers/scsi subdirectories
120 `git log --since="2 weeks ago" -- gitk`::
122         Show the changes during the last two weeks to the file 'gitk'.
123         The "--" is necessary to avoid confusion with the *branch* named
124         'gitk'
126 `git log --name-status release..test`::
128         Show the commits that are in the "test" branch but not yet
129         in the "release" branch, along with the list of paths
130         each commit modifies.
132 `git log --follow builtin/rev-list.c`::
134         Shows the commits that changed builtin/rev-list.c, including
135         those commits that occurred before the file was given its
136         present name.
138 `git log --branches --not --remotes=origin`::
140         Shows all commits that are in any of local branches but not in
141         any of remote-tracking branches for 'origin' (what you have that
142         origin doesn't).
144 `git log master --not --remotes=*/master`::
146         Shows all commits that are in local master but not in any remote
147         repository master branches.
149 `git log -p -m --first-parent`::
151         Shows the history including change diffs, but only from the
152         "main branch" perspective, skipping commits that come from merged
153         branches, and showing full diffs of changes introduced by the merges.
154         This makes sense only when following a strict policy of merging all
155         topic branches when staying on a single integration branch.
157 `git log -L '/int main/',/^}/:main.c`::
159         Shows how the function `main()` in the file 'main.c' evolved
160         over time.
162 `git log -3`::
163         Limits the number of commits to show to 3.
165 DISCUSSION
166 ----------
168 include::i18n.txt[]
170 CONFIGURATION
171 -------------
173 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
174 for settings related to diff generation.
176 format.pretty::
177         Default for the `--format` option.  (See "PRETTY FORMATS" above.)
178         Defaults to "medium".
180 i18n.logOutputEncoding::
181         Encoding to use when displaying logs.  (See "Discussion", above.)
182         Defaults to the value of `i18n.commitEncoding` if set, UTF-8
183         otherwise.
185 log.date::
186         Default format for human-readable dates.  (Compare the
187         `--date` option.)  Defaults to "default", which means to write
188         dates like `Sat May 8 19:35:34 2010 -0500`.
190 log.showroot::
191         If `false`, 'git log' and related commands will not treat the
192         initial commit as a big creation event.  Any root commits in
193         `git log -p` output would be shown without a diff attached.
194         The default is `true`.
196 mailmap.*::
197         See linkgit:git-shortlog[1].
199 notes.displayRef::
200         Which refs, in addition to the default set by `core.notesRef`
201         or 'GIT_NOTES_REF', to read notes from when showing commit
202         messages with the 'log' family of commands.  See
203         linkgit:git-notes[1].
205 May be an unabbreviated ref name or a glob and may be specified
206 multiple times.  A warning will be issued for refs that do not exist,
207 but a glob that does not match any refs is silently ignored.
209 This setting can be disabled by the `--no-notes` option,
210 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
211 and overridden by the `--notes=<ref>` option.
215 Part of the linkgit:git[1] suite