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