man1/git-rev-list.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-REV-LIST" 1 "" "" ""
  21 .SH NAME
  22 git-rev-list \- Lists commit objects in reverse chronological order
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 git\-rev\-list [ \-\-max\-count=number ]
  27              [ \-\-max\-age=timestamp ]
  28              [ \-\-min\-age=timestamp ]
  29              [ \-\-sparse ]
  30              [ \-\-no\-merges ]
  31              [ \-\-remove\-empty ]
  32              [ \-\-all ]
  33              [ [ \-\-merge\-order [ \-\-show\-breaks ] ] | [ \-\-topo\-order ] ]
  34              [ \-\-parents ]
  35              [ \-\-objects [ \-\-unpacked ] ]
  36              [ \-\-pretty | \-\-header ]
  37              [ \-\-bisect ]
  38              <commit>... [ \-\- <paths>... ]
  39 .fi
  40
  41 .SH "DESCRIPTION"
  42
  43
  44 Lists commit objects in reverse chronological order starting at the given commit(s), taking ancestry relationship into account\&. This is useful to produce human\-readable log output\&.
  45
  46
  47 Commits which are stated with a preceding ^ cause listing to stop at that point\&. Their parents are implied\&. "git\-rev\-list foo bar ^baz" thus means "list all the commits which are included in foo and bar, but not in baz"\&.
  48
  49
  50 A special notation <commit1>\&.\&.<commit2> can be used as a short\-hand for ^<commit1> <commit2>\&.
  51
  52 .SH "OPTIONS"
  53
  54 .TP
  55 \-\-pretty
  56 Print the contents of the commit changesets in human\-readable form\&.
  57
  58 .TP
  59 \-\-header
  60 Print the contents of the commit in raw\-format; each record is separated with a NUL character\&.
  61
  62 .TP
  63 \-\-objects
  64 Print the object IDs of any object referenced by the listed commits\&. git\-rev\-list \-\-objects foo ^bar thus means "send me all object IDs which I need to download if I have the commit object bar, but not foo"\&.
  65
  66 .TP
  67 \-\-unpacked
  68 Only useful with \-\-objects; print the object IDs that are not in packs\&.
  69
  70 .TP
  71 \-\-bisect
  72 Limit output to the one commit object which is roughly halfway between the included and excluded commits\&. Thus, if git\-rev\-list \-\-bisect foo bar baz outputs midpoint, the output of git\-rev\-list foo ^midpoint and git\-rev\-list midpoint bar baz would be of roughly the same length\&. Finding the change which introduces a regression is thus reduced to a binary search: repeatedly generate and test new 'midpoint's until the commit chain is of length one\&.
  73
  74 .TP
  75 \-\-max\-count
  76 Limit the number of commits output\&.
  77
  78 .TP
  79 \-\-max\-age=timestamp, \-\-min\-age=timestamp
  80 Limit the commits output to specified time range\&.
  81
  82 .TP
  83 \-\-sparse
  84 When optional paths are given, the command outputs only the commits that changes at least one of them, and also ignores merges that do not touch the given paths\&. This flag makes the command output all eligible commits (still subject to count and age limitation), but apply merge simplification nevertheless\&.
  85
  86 .TP
  87 \-\-remove\-empty
  88 Stop when a given path disappears from the tree\&.
  89
  90 .TP
  91 \-\-all
  92 Pretend as if all the refs in $GIT_DIR/refs/ are listed on the command line as <commit>\&.
  93
  94 .TP
  95 \-\-topo\-order
  96 By default, the commits are shown in reverse chronological order\&. This option makes them appear in topological order (i\&.e\&. descendant commits are shown before their parents)\&.
  97
  98 .TP
  99 \-\-merge\-order
 100 When specified the commit history is decomposed into a unique sequence of minimal, non\-linear epochs and maximal, linear epochs\&. Non\-linear epochs are then linearised by sorting them into merge order, which is described below\&.
 101
 102 Maximal, linear epochs correspond to periods of sequential development\&. Minimal, non\-linear epochs correspond to periods of divergent development followed by a converging merge\&. The theory of epochs is described in more detail at http://blackcubes\&.dyndns\&.org/epoch/: \fIhttp://blackcubes.dyndns.org/epoch/\fR\&.
 103
 104 The merge order for a non\-linear epoch is defined as a linearisation for which the following invariants are true:
 105
 106 .RS
 107 .TP 3
 108 1.
 109 if a commit P is reachable from commit N, commit P sorts after commit N in the linearised list\&.
 110 .TP
 111 2.
 112 if Pi and Pj are any two parents of a merge M (with i < j), then any commit N, such that N is reachable from Pj but not reachable from Pi, sorts before all commits reachable from Pi\&.
 113
 114 Invariant 1 states that later commits appear before earlier commits they are derived from\&.
 115
 116 Invariant 2 states that commits unique to "later" parents in a merge, appear before all commits from "earlier" parents of a merge\&.
 117 .LP
 118 .RE
 119 .IP
 120
 121 .TP
 122 \-\-show\-breaks
 123 Each item of the list is output with a 2\-character prefix consisting of one of: (|), (^), (=) followed by a space\&.
 124
 125 Commits marked with (=) represent the boundaries of minimal, non\-linear epochs and correspond either to the start of a period of divergent development or to the end of such a period\&.
 126
 127 Commits marked with (|) are direct parents of commits immediately preceding the marked commit in the list\&.
 128
 129 Commits marked with (^) are not parents of the immediately preceding commit\&. These "breaks" represent necessary discontinuities implied by trying to represent an arbitrary DAG in a linear form\&.
 130
 131 \-\-show\-breaks is only valid if \-\-merge\-order is also specified\&.
 132
 133 .SH "AUTHOR"
 134
 135
 136 Written by Linus Torvalds <torvalds@osdl\&.org>
 137
 138
 139 Original \-\-merge\-order logic by Jon Seymour <jon\&.seymour@gmail\&.com>
 140
 141 .SH "DOCUMENTATION"
 142
 143
 144 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 145
 146 .SH "GIT"
 147
 148
 149 Part of the \fBgit\fR(7) suite
 150