builtin/log.c: make usage string consistent with doc
[git.git] / Documentation / git-log.txt
bloba976534ab870a89a236ec7190f985e20f771e7f7
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 <revision range>::
66         Show only commits in the specified revision range.  When no
67         <revision range> is specified, it defaults to `HEAD` (i.e. the
68         whole history leading to the current commit).  `origin..HEAD`
69         specifies all the commits reachable from the current commit
70         (i.e. `HEAD`), but not from `origin`. For a complete list of
71         ways to spell <revision range>, see the "Specifying Ranges"
72         section of linkgit:gitrevisions[7].
74 [\--] <path>...::
75         Show only commits that are enough to explain how the files
76         that match the specified paths came to be.  See "History
77         Simplification" below for details and other simplification
78         modes.
80 Paths may need to be prefixed with "\-- " to separate them from
81 options or the revision range, when confusion arises.
83 include::rev-list-options.txt[]
85 include::pretty-formats.txt[]
87 Common diff options
88 -------------------
90 :git-log: 1
91 include::diff-options.txt[]
93 include::diff-generate-patch.txt[]
95 Examples
96 --------
97 `git log --no-merges`::
99         Show the whole commit history, but skip any merges
101 `git log v2.6.12.. include/scsi drivers/scsi`::
103         Show all commits since version 'v2.6.12' that changed any file
104         in the include/scsi or drivers/scsi subdirectories
106 `git log --since="2 weeks ago" -- gitk`::
108         Show the changes during the last two weeks to the file 'gitk'.
109         The "--" is necessary to avoid confusion with the *branch* named
110         'gitk'
112 `git log --name-status release..test`::
114         Show the commits that are in the "test" branch but not yet
115         in the "release" branch, along with the list of paths
116         each commit modifies.
118 `git log --follow builtin-rev-list.c`::
120         Shows the commits that changed builtin-rev-list.c, including
121         those commits that occurred before the file was given its
122         present name.
124 `git log --branches --not --remotes=origin`::
126         Shows all commits that are in any of local branches but not in
127         any of remote-tracking branches for 'origin' (what you have that
128         origin doesn't).
130 `git log master --not --remotes=*/master`::
132         Shows all commits that are in local master but not in any remote
133         repository master branches.
135 `git log -p -m --first-parent`::
137         Shows the history including change diffs, but only from the
138         "main branch" perspective, skipping commits that come from merged
139         branches, and showing full diffs of changes introduced by the merges.
140         This makes sense only when following a strict policy of merging all
141         topic branches when staying on a single integration branch.
143 `git log -3`::
144         Limits the number of commits to show to 3.
146 Discussion
147 ----------
149 include::i18n.txt[]
151 Configuration
152 -------------
154 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
155 for settings related to diff generation.
157 format.pretty::
158         Default for the `--format` option.  (See "PRETTY FORMATS" above.)
159         Defaults to "medium".
161 i18n.logOutputEncoding::
162         Encoding to use when displaying logs.  (See "Discussion", above.)
163         Defaults to the value of `i18n.commitEncoding` if set, UTF-8
164         otherwise.
166 log.date::
167         Default format for human-readable dates.  (Compare the
168         `--date` option.)  Defaults to "default", which means to write
169         dates like `Sat May 8 19:35:34 2010 -0500`.
171 log.showroot::
172         If `false`, 'git log' and related commands will not treat the
173         initial commit as a big creation event.  Any root commits in
174         `git log -p` output would be shown without a diff attached.
175         The default is `true`.
177 mailmap.*::
178         See linkgit:git-shortlog[1].
180 notes.displayRef::
181         Which refs, in addition to the default set by `core.notesRef`
182         or 'GIT_NOTES_REF', to read notes from when showing commit
183         messages with the 'log' family of commands.  See
184         linkgit:git-notes[1].
186 May be an unabbreviated ref name or a glob and may be specified
187 multiple times.  A warning will be issued for refs that do not exist,
188 but a glob that does not match any refs is silently ignored.
190 This setting can be disabled by the `--no-notes` option,
191 overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
192 and overridden by the `--notes=<ref>` option.
196 Part of the linkgit:git[1] suite