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