Documentation / git-rev-list.txton commit Merge with gitk. (f10e0e0)
   1git-rev-list(1)
   2===============
   3v0.1, May 2005
   4
   5NAME
   6----
   7git-rev-list - Lists commit objects in reverse chronological order
   8
   9
  10SYNOPSIS
  11--------
  12'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--bisect* ] [ *--pretty* ] [ *--objects* ] [ *--merge-order* [ *--show-breaks* ] ] <commit> [ <commit> ...] [ ^<commit> ...]
  13
  14DESCRIPTION
  15-----------
  16Lists commit objects in reverse chronological order starting at the
  17given commit(s), taking ancestry relationship into account.  This is
  18useful to produce human-readable log output.
  19
  20Commits which are stated with a preceding '^' cause listing to stop at
  21that point. Their parents are implied. "git-rev-list foo bar ^baz" thus
  22means "list all the commits which are included in 'foo' and 'bar', but
  23not in 'baz'".
  24
  25If *--pretty* is specified, print the contents of the commit changesets
  26in human-readable form.
  27
  28The *--objects* flag causes 'git-rev-list' to print the object IDs of
  29any object referenced by the listed commits. 'git-rev-list --objects foo
  30^bar' thus means "send me all object IDs which I need to download if
  31I have the commit object 'bar', but not 'foo'".
  32
  33The *--bisect* flag limits output to the one commit object which is
  34roughly halfway between the included and excluded commits. Thus,
  35if "git-rev-list --bisect foo ^bar ^baz" outputs 'midpoint', the output
  36of "git-rev-list foo ^midpoint" and "git-rev-list midpoint ^bar ^baz"
  37would be of roughly the same length. Finding the change which introduces
  38a regression is thus reduced to a binary search: repeatedly generate and
  39test new 'midpoint's until the commit chain is of length one.
  40
  41If *--merge-order* is specified, the commit history is decomposed into a
  42unique sequence of minimal, non-linear epochs and maximal, linear epochs.
  43Non-linear epochs are then linearised by sorting them into merge order, which
  44is described below.
  45
  46Maximal, linear epochs correspond to periods of sequential development.
  47Minimal, non-linear epochs correspond to periods of divergent development
  48followed by a converging merge. The theory of epochs is described in more
  49detail at
  50link:http://blackcubes.dyndns.org/epoch/[http://blackcubes.dyndns.org/epoch/].
  51
  52The merge order for a non-linear epoch is defined as a linearisation for which
  53the following invariants are true:
  54
  55    1. if a commit P is reachable from commit N, commit P sorts after commit N
  56       in the linearised list.
  57    2. if Pi and Pj are any two parents of a merge M (with i < j), then any
  58       commit N, such that N is reachable from Pj but not reachable from Pi,
  59       sorts before all commits reachable from Pi.
  60
  61Invariant 1 states that later commits appear before earlier commits they are
  62derived from.
  63
  64Invariant 2 states that commits unique to "later" parents in a merge, appear
  65before all commits from "earlier" parents of a merge.
  66
  67If *--show-breaks* is specified, each item of the list is output with a
  682-character prefix consisting of one of: (|), (^), (=) followed by a space.
  69
  70Commits marked with (=) represent the boundaries of minimal, non-linear epochs
  71and correspond either to the start of a period of divergent development or to
  72the end of such a period.
  73
  74Commits marked with (|) are direct parents of commits immediately preceding
  75the marked commit in the list.
  76
  77Commits marked with (^) are not parents of the immediately preceding commit.
  78These "breaks" represent necessary discontinuities implied by trying to
  79represent an arbtirary DAG in a linear form.
  80
  81*--show-breaks* is only valid if *--merge-order* is also specified.
  82
  83Author
  84------
  85Written by Linus Torvalds <torvalds@osdl.org>
  86
  87Original *--merge-order* logic by Jon Seymour <jon.seymour@gmail.com>
  88
  89Documentation
  90--------------
  91Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  92
  93GIT
  94---
  95Part of the link:git.html[git] suite
  96