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`.
  47
  48 --source::
  49         Print out the ref name given on the command line by which each
  50         commit was reached.
  51
  52 --[no-]use-mailmap::
  53         Use mailmap file to map author and committer names and email
  54         addresses to canonical real names and email addresses. See
  55         linkgit:git-shortlog[1].
  56
  57 --full-diff::
  58         Without this flag, `git log -p <path>...` shows commits that
  59         touch the specified paths, and diffs about the same specified
  60         paths.  With this, the full diff is shown for commits that touch
  61         the specified paths; this means that "<path>..." limits only
  62         commits, and doesn't limit diff for those commits.
  63 +
  64 Note that this affects all diff-based output types, e.g. those
  65 produced by `--stat`, etc.
  66
  67 --log-size::
  68         Include a line ``log size <number>'' in the output for each commit,
  69         where <number> is the length of that commit's message in bytes.
  70         Intended to speed up tools that read log messages from `git log`
  71         output by allowing them to allocate space in advance.
  72
  73 -L <start>,<end>:<file>::
  74 -L :<funcname>:<file>::
  75         Trace the evolution of the line range given by "<start>,<end>"
  76         (or the function name regex <funcname>) within the <file>.  You may
  77         not give any pathspec limiters.  This is currently limited to
  78         a walk starting from a single revision, i.e., you may only
  79         give zero or one positive revision arguments, and
  80         <start> and <end> (or <funcname>) must exist in the starting revision.
  81         You can specify this option more than once. Implies `--patch`.
  82         Patch output can be suppressed using `--no-patch`, but other diff formats
  83         (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
  84         `--name-only`, `--name-status`, `--check`) are not currently implemented.
  85 +
  86 include::line-range-format.txt[]
  87
  88 <revision range>::
  89         Show only commits in the specified revision range.  When no
  90         <revision range> is specified, it defaults to `HEAD` (i.e. the
  91         whole history leading to the current commit).  `origin..HEAD`
  92         specifies all the commits reachable from the current commit
  93         (i.e. `HEAD`), but not from `origin`. For a complete list of
  94         ways to spell <revision range>, see the 'Specifying Ranges'
  95         section of linkgit:gitrevisions[7].
  96
  97 [--] <path>...::
  98         Show only commits that are enough to explain how the files
  99         that match the specified paths came to be.  See 'History
 100         Simplification' below for details and other simplification
 101         modes.
 102 +
 103 Paths may need to be prefixed with `--` to separate them from
 104 options or the revision range, when confusion arises.
 105
 106 include::rev-list-options.txt[]
 107
 108 include::pretty-formats.txt[]
 109
 110 COMMON DIFF OPTIONS
 111 -------------------
 112
 113 :git-log: 1
 114 include::diff-options.txt[]
 115
 116 include::diff-generate-patch.txt[]
 117
 118 EXAMPLES
 119 --------
 120 `git log --no-merges`::
 121
 122         Show the whole commit history, but skip any merges
 123
 124 `git log v2.6.12.. include/scsi drivers/scsi`::
 125
 126         Show all commits since version 'v2.6.12' that changed any file
 127         in the `include/scsi` or `drivers/scsi` subdirectories
 128
 129 `git log --since="2 weeks ago" -- gitk`::
 130
 131         Show the changes during the last two weeks to the file 'gitk'.
 132         The `--` is necessary to avoid confusion with the *branch* named
 133         'gitk'
 134
 135 `git log --name-status release..test`::
 136
 137         Show the commits that are in the "test" branch but not yet
 138         in the "release" branch, along with the list of paths
 139         each commit modifies.
 140
 141 `git log --follow builtin/rev-list.c`::
 142
 143         Shows the commits that changed `builtin/rev-list.c`, including
 144         those commits that occurred before the file was given its
 145         present name.
 146
 147 `git log --branches --not --remotes=origin`::
 148
 149         Shows all commits that are in any of local branches but not in
 150         any of remote-tracking branches for 'origin' (what you have that
 151         origin doesn't).
 152
 153 `git log master --not --remotes=*/master`::
 154
 155         Shows all commits that are in local master but not in any remote
 156         repository master branches.
 157
 158 `git log -p -m --first-parent`::
 159
 160         Shows the history including change diffs, but only from the
 161         ``main branch'' perspective, skipping commits that come from merged
 162         branches, and showing full diffs of changes introduced by the merges.
 163         This makes sense only when following a strict policy of merging all
 164         topic branches when staying on a single integration branch.
 165
 166 `git log -L '/int main/',/^}/:main.c`::
 167
 168         Shows how the function `main()` in the file `main.c` evolved
 169         over time.
 170
 171 `git log -3`::
 172
 173         Limits the number of commits to show to 3.
 174
 175 DISCUSSION
 176 ----------
 177
 178 include::i18n.txt[]
 179
 180 CONFIGURATION
 181 -------------
 182
 183 See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
 184 for settings related to diff generation.
 185
 186 format.pretty::
 187         Default for the `--format` option.  (See 'Pretty Formats' above.)
 188         Defaults to `medium`.
 189
 190 i18n.logOutputEncoding::
 191         Encoding to use when displaying logs.  (See 'Discussion' above.)
 192         Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
 193         otherwise.
 194
 195 log.date::
 196         Default format for human-readable dates.  (Compare the
 197         `--date` option.)  Defaults to "default", which means to write
 198         dates like `Sat May 8 19:35:34 2010 -0500`.
 199 +
 200 If the format is set to "auto:foo" and the pager is in use, format
 201 "foo" will be the used for the date format. Otherwise "default" will
 202 be used.
 203
 204 log.follow::
 205         If `true`, `git log` will act as if the `--follow` option was used when
 206         a single <path> is given.  This has the same limitations as `--follow`,
 207         i.e. it cannot be used to follow multiple files and does not work well
 208         on non-linear history.
 209
 210 log.showRoot::
 211         If `false`, `git log` and related commands will not treat the
 212         initial commit as a big creation event.  Any root commits in
 213         `git log -p` output would be shown without a diff attached.
 214         The default is `true`.
 215
 216 log.showSignature::
 217         If `true`, `git log` and related commands will act as if the
 218         `--show-signature` option was passed to them.
 219
 220 mailmap.*::
 221         See linkgit:git-shortlog[1].
 222
 223 notes.displayRef::
 224         Which refs, in addition to the default set by `core.notesRef`
 225         or `GIT_NOTES_REF`, to read notes from when showing commit
 226         messages with the `log` family of commands.  See
 227         linkgit:git-notes[1].
 228 +
 229 May be an unabbreviated ref name or a glob and may be specified
 230 multiple times.  A warning will be issued for refs that do not exist,
 231 but a glob that does not match any refs is silently ignored.
 232 +
 233 This setting can be disabled by the `--no-notes` option,
 234 overridden by the `GIT_NOTES_DISPLAY_REF` environment variable,
 235 and overridden by the `--notes=<ref>` option.
 236
 237 GIT
 238 ---
 239 Part of the linkgit:git[1] suite