Documentation/git-log.txt

   1 git-log(1)
   2 ==========
   3
   4 NAME
   5 ----
   6 git-log - Show commit logs
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git log' [<options>] [<revision range>] [[--] <path>...]
  13
  14 DESCRIPTION
  15 -----------
  16 Shows the commit logs.
  17
  18 :git-log: 1
  19 include::rev-list-description.txt[]
  20
  21 The command takes options applicable to the linkgit:git-rev-list[1]
  22 command to control what is shown and how, and options applicable to
  23 the linkgit:git-diff[1] command to control how the changes
  24 each commit introduces are shown.
  25
  26
  27 OPTIONS
  28 -------
  29
  30 --follow::
  31         Continue listing the history of a file beyond renames
  32         (works only for a single file).
  33
  34 --no-decorate::
  35 --decorate[=short|full|auto|no]::
  36         Print out the ref names of any commits that are shown. If 'short' is
  37         specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
  38         'refs/remotes/' will not be printed. If 'full' is specified, the
  39         full ref name (including prefix) will be printed. If 'auto' is
  40         specified, then if the output is going to a terminal, the ref names
  41         are shown as if 'short' were given, otherwise no ref names are
  42         shown. The default option is 'short'.
  43
  44 --decorate-refs=<pattern>::
  45 --decorate-refs-exclude=<pattern>::
  46         If no `--decorate-refs` is given, pretend as if all refs were
  47         included.  For each candidate, do not use it for decoration if it
  48         matches any patterns given to `--decorate-refs-exclude` or if it
  49         doesn't match any of the patterns given to `--decorate-refs`. The
  50         `log.excludeDecoration` config option allows excluding refs from
  51         the decorations, but an explicit `--decorate-refs` pattern will
  52         override a match in `log.excludeDecoration`.
  53
  54 --source::
  55         Print out the ref name given on the command line by which each
  56         commit was reached.
  57
  58 --[no-]mailmap::
  59 --[no-]use-mailmap::
  60         Use mailmap file to map author and committer names and email
  61         addresses to canonical real names and email addresses. See
  62         linkgit:git-shortlog[1].
  63
  64 --full-diff::
  65         Without this flag, `git log -p <path>...` shows commits that
  66         touch the specified paths, and diffs about the same specified
  67         paths.  With this, the full diff is shown for commits that touch
  68         the specified paths; this means that "<path>..." limits only
  69         commits, and doesn't limit diff for those commits.
  70 +
  71 Note that this affects all diff-based output types, e.g. those
  72 produced by `--stat`, etc.
  73
  74 --log-size::
  75         Include a line ``log size <number>'' in the output for each commit,
  76         where <number> is the length of that commit's message in bytes.
  77         Intended to speed up tools that read log messages from `git log`
  78         output by allowing them to allocate space in advance.
  79
  80 -L <start>,<end>:<file>::
  81 -L :<funcname>:<file>::
  82         Trace the evolution of the line range given by "<start>,<end>"
  83         (or the function name regex <funcname>) within the <file>.  You may
  84         not give any pathspec limiters.  This is currently limited to
  85         a walk starting from a single revision, i.e., you may only
  86         give zero or one positive revision arguments, and
  87         <start> and <end> (or <funcname>) must exist in the starting revision.
  88         You can specify this option more than once. Implies `--patch`.
  89         Patch output can be suppressed using `--no-patch`, but other diff formats
  90         (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
  91         `--name-only`, `--name-status`, `--check`) are not currently implemented.
  92 +
  93 include::line-range-format.txt[]
  94
  95 <revision range>::
  96         Show only commits in the specified revision range.  When no
  97         <revision range> is specified, it defaults to `HEAD` (i.e. the
  98         whole history leading to the current commit).  `origin..HEAD`
  99         specifies all the commits reachable from the current commit
 100         (i.e. `HEAD`), but not from `origin`. For a complete list of
 101         ways to spell <revision range>, see the 'Specifying Ranges'
 102         section of linkgit:gitrevisions[7].
 103
 104 [--] <path>...::
 105         Show only commits that are enough to explain how the files
 106         that match the specified paths came to be.  See 'History
 107         Simplification' below for details and other simplification
 108         modes.
 109 +
 110 Paths may need to be prefixed with `--` to separate them from
 111 options or the revision range, when confusion arises.
 112
 113 include::rev-list-options.txt[]
 114
 115 include::pretty-formats.txt[]
 116
 117 DIFF FORMATTING
 118 ---------------
 119
 120 By default, `git log` does not generate any diff output. The options
 121 below can be used to show the changes made by each commit.
 122
 123 Note that unless one of `--diff-merges` variants (including short
 124 `-m`, `-c`, and `--cc` options) is explicitly given, merge commits
 125 will not show a diff, even if a diff format like `--patch` is
 126 selected, nor will they match search options like `-S`. The exception
 127 is when `--first-parent` is in use, in which case `first-parent` is
 128 the default format.
 129
 130 --diff-merges=(off|none|first-parent|1|separate|m|combined|c|dense-combined|cc)::
 131 --no-diff-merges::
 132         Specify diff format to be used for merge commits. Default is
 133         `off` unless `--first-parent` is in use, in which case
 134         `first-parent` is the default.
 135 +
 136 --diff-merges=(off|none):::
 137 --no-diff-merges:::
 138         Disable output of diffs for merge commits. Useful to override
 139         implied value.
 140 +
 141 --diff-merges=first-parent:::
 142 --diff-merges=1:::
 143         This option makes merge commits show the full diff with
 144         respect to the first parent only.
 145 +
 146 --diff-merges=separate:::
 147 --diff-merges=m:::
 148 -m:::
 149         This makes merge commits show the full diff with respect to
 150         each of the parents. Separate log entry and diff is generated
 151         for each parent. `-m` doesn't produce any output without `-p`.
 152 +
 153 --diff-merges=combined:::
 154 --diff-merges=c:::
 155 -c:::
 156         With this option, diff output for a merge commit shows the
 157         differences from each of the parents to the merge result
 158         simultaneously instead of showing pairwise diff between a
 159         parent and the result one at a time. Furthermore, it lists
 160         only files which were modified from all parents. `-c` implies
 161         `-p`.
 162 +
 163 --diff-merges=dense-combined:::
 164 --diff-merges=cc:::
 165 --cc:::
 166         With this option the output produced by
 167         `--diff-merges=combined` is further compressed by omitting
 168         uninteresting hunks whose contents in the parents have only
 169         two variants and the merge result picks one of them without
 170         modification.  `--cc` implies `-p`.
 171
 172 --combined-all-paths::
 173         This flag causes combined diffs (used for merge commits) to
 174         list the name of the file from all parents.  It thus only has
 175         effect when `--diff-merges=[dense-]combined` is in use, and
 176         is likely only useful if filename changes are detected (i.e.
 177         when either rename or copy detection have been requested).
 178
 179
 180 :git-log: 1
 181 include::diff-options.txt[]
 182
 183 include::diff-generate-patch.txt[]
 184
 185 EXAMPLES
 186 --------
 187 `git log --no-merges`::
 188
 189         Show the whole commit history, but skip any merges
 190
 191 `git log v2.6.12.. include/scsi drivers/scsi`::
 192
 193         Show all commits since version 'v2.6.12' that changed any file
 194         in the `include/scsi` or `drivers/scsi` subdirectories
 195
 196 `git log --since="2 weeks ago" -- gitk`::
 197
 198         Show the changes during the last two weeks to the file 'gitk'.
 199         The `--` is necessary to avoid confusion with the *branch* named
 200         'gitk'
 201
 202 `git log --name-status release..test`::
 203
 204         Show the commits that are in the "test" branch but not yet
 205         in the "release" branch, along with the list of paths
 206         each commit modifies.
 207
 208 `git log --follow builtin/rev-list.c`::
 209
 210         Shows the commits that changed `builtin/rev-list.c`, including
 211         those commits that occurred before the file was given its
 212         present name.
 213
 214 `git log --branches --not --remotes=origin`::
 215
 216         Shows all commits that are in any of local branches but not in
 217         any of remote-tracking branches for 'origin' (what you have that
 218         origin doesn't).
 219
 220 `git log master --not --remotes=*/master`::
 221
 222         Shows all commits that are in local master but not in any remote
 223         repository master branches.
 224
 225 `git log -p -m --first-parent`::
 226
 227         Shows the history including change diffs, but only from the
 228         ``main branch'' perspective, skipping commits that come from merged
 229         branches, and showing full diffs of changes introduced by the merges.
 230         This makes sense only when following a strict policy of merging all
 231         topic branches when staying on a single integration branch.
 232
 233 `git log -L '/int main/',/^}/:main.c`::
 234
 235         Shows how the function `main()` in the file `main.c` evolved
 236         over time.
 237
 238 `git log -3`::
 239
 240         Limits the number of commits to show to 3.
 241
 242 DISCUSSION
 243 ----------
 244
 245 include::i18n.txt[]
 246
 247 CONFIGURATION
 248 -------------
 249
 250 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
 251 for settings related to diff generation.
 252
 253 format.pretty::
 254         Default for the `--format` option.  (See 'Pretty Formats' above.)
 255         Defaults to `medium`.
 256
 257 i18n.logOutputEncoding::
 258         Encoding to use when displaying logs.  (See 'Discussion' above.)
 259         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
 260         otherwise.
 261
 262 log.date::
 263         Default format for human-readable dates.  (Compare the
 264         `--date` option.)  Defaults to "default", which means to write
 265         dates like `Sat May 8 19:35:34 2010 -0500`.
 266 +
 267 If the format is set to "auto:foo" and the pager is in use, format
 268 "foo" will be the used for the date format. Otherwise "default" will
 269 be used.
 270
 271 log.follow::
 272         If `true`, `git log` will act as if the `--follow` option was used when
 273         a single <path> is given.  This has the same limitations as `--follow`,
 274         i.e. it cannot be used to follow multiple files and does not work well
 275         on non-linear history.
 276
 277 log.showRoot::
 278         If `false`, `git log` and related commands will not treat the
 279         initial commit as a big creation event.  Any root commits in
 280         `git log -p` output would be shown without a diff attached.
 281         The default is `true`.
 282
 283 log.showSignature::
 284         If `true`, `git log` and related commands will act as if the
 285         `--show-signature` option was passed to them.
 286
 287 mailmap.*::
 288         See linkgit:git-shortlog[1].
 289
 290 notes.displayRef::
 291         Which refs, in addition to the default set by `core.notesRef`
 292         or `GIT_NOTES_REF`, to read notes from when showing commit
 293         messages with the `log` family of commands.  See
 294         linkgit:git-notes[1].
 295 +
 296 May be an unabbreviated ref name or a glob and may be specified
 297 multiple times.  A warning will be issued for refs that do not exist,
 298 but a glob that does not match any refs is silently ignored.
 299 +
 300 This setting can be disabled by the `--no-notes` option,
 301 overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
 302 and overridden by the `--notes=<ref>` option.
 303
 304 GIT
 305 ---
 306 Part of the linkgit:git[1] suite