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 COMMON DIFF OPTIONS
 115 -------------------
 116
 117 :git-log: 1
 118 include::diff-options.txt[]
 119
 120 include::diff-generate-patch.txt[]
 121
 122 EXAMPLES
 123 --------
 124 `git log --no-merges`::
 125
 126         Show the whole commit history, but skip any merges
 127
 128 `git log v2.6.12.. include/scsi drivers/scsi`::
 129
 130         Show all commits since version 'v2.6.12' that changed any file
 131         in the `include/scsi` or `drivers/scsi` subdirectories
 132
 133 `git log --since="2 weeks ago" -- gitk`::
 134
 135         Show the changes during the last two weeks to the file 'gitk'.
 136         The `--` is necessary to avoid confusion with the *branch* named
 137         'gitk'
 138
 139 `git log --name-status release..test`::
 140
 141         Show the commits that are in the "test" branch but not yet
 142         in the "release" branch, along with the list of paths
 143         each commit modifies.
 144
 145 `git log --follow builtin/rev-list.c`::
 146
 147         Shows the commits that changed `builtin/rev-list.c`, including
 148         those commits that occurred before the file was given its
 149         present name.
 150
 151 `git log --branches --not --remotes=origin`::
 152
 153         Shows all commits that are in any of local branches but not in
 154         any of remote-tracking branches for 'origin' (what you have that
 155         origin doesn't).
 156
 157 `git log master --not --remotes=*/master`::
 158
 159         Shows all commits that are in local master but not in any remote
 160         repository master branches.
 161
 162 `git log -p -m --first-parent`::
 163
 164         Shows the history including change diffs, but only from the
 165         ``main branch'' perspective, skipping commits that come from merged
 166         branches, and showing full diffs of changes introduced by the merges.
 167         This makes sense only when following a strict policy of merging all
 168         topic branches when staying on a single integration branch.
 169
 170 `git log -L '/int main/',/^}/:main.c`::
 171
 172         Shows how the function `main()` in the file `main.c` evolved
 173         over time.
 174
 175 `git log -3`::
 176
 177         Limits the number of commits to show to 3.
 178
 179 DISCUSSION
 180 ----------
 181
 182 include::i18n.txt[]
 183
 184 CONFIGURATION
 185 -------------
 186
 187 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
 188 for settings related to diff generation.
 189
 190 format.pretty::
 191         Default for the `--format` option.  (See 'Pretty Formats' above.)
 192         Defaults to `medium`.
 193
 194 i18n.logOutputEncoding::
 195         Encoding to use when displaying logs.  (See 'Discussion' above.)
 196         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
 197         otherwise.
 198
 199 log.date::
 200         Default format for human-readable dates.  (Compare the
 201         `--date` option.)  Defaults to "default", which means to write
 202         dates like `Sat May 8 19:35:34 2010 -0500`.
 203 +
 204 If the format is set to "auto:foo" and the pager is in use, format
 205 "foo" will be the used for the date format. Otherwise "default" will
 206 be used.
 207
 208 log.follow::
 209         If `true`, `git log` will act as if the `--follow` option was used when
 210         a single <path> is given.  This has the same limitations as `--follow`,
 211         i.e. it cannot be used to follow multiple files and does not work well
 212         on non-linear history.
 213
 214 log.showRoot::
 215         If `false`, `git log` and related commands will not treat the
 216         initial commit as a big creation event.  Any root commits in
 217         `git log -p` output would be shown without a diff attached.
 218         The default is `true`.
 219
 220 log.showSignature::
 221         If `true`, `git log` and related commands will act as if the
 222         `--show-signature` option was passed to them.
 223
 224 mailmap.*::
 225         See linkgit:git-shortlog[1].
 226
 227 notes.displayRef::
 228         Which refs, in addition to the default set by `core.notesRef`
 229         or `GIT_NOTES_REF`, to read notes from when showing commit
 230         messages with the `log` family of commands.  See
 231         linkgit:git-notes[1].
 232 +
 233 May be an unabbreviated ref name or a glob and may be specified
 234 multiple times.  A warning will be issued for refs that do not exist,
 235 but a glob that does not match any refs is silently ignored.
 236 +
 237 This setting can be disabled by the `--no-notes` option,
 238 overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
 239 and overridden by the `--notes=<ref>` option.
 240
 241 GIT
 242 ---
 243 Part of the linkgit:git[1] suite