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 \fIgit\-rev\-list\fR [ \-\-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 | \-\-objects\-edge] [ \-\-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 \fI^\fR 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 \fIfoo\fR and \fIbar\fR, but not in \fIbaz\fR"\&.
  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\&. \fIgit\-rev\-list \-\-objects foo ^bar\fR thus means "send me all object IDs which I need to download if I have the commit object \fIbar\fR, but not \fIfoo\fR"\&.
  65
  66 .TP
  67 \-\-objects\-edge
  68 Similar to \-\-objects, but also print the IDs of excluded commits refixed with a \- character\&. This is used by git\-pack\-objects to build \fIthin\fR pack, which records objects in deltified form based on objects contained in these excluded commits to reduce network traffic\&.
  69
  70 .TP
  71 \-\-unpacked
  72 Only useful with \-\-objects; print the object IDs that are not in packs\&.
  73
  74 .TP
  75 \-\-bisect
  76 Limit output to the one commit object which is roughly halfway between the included and excluded commits\&. Thus, if \fIgit\-rev\-list \-\-bisect foo bar baz\fR outputs \fImidpoint\fR, the output of \fIgit\-rev\-list foo ^midpoint\fR and \fIgit\-rev\-list midpoint bar baz\fR 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\&.
  77
  78 .TP
  79 \-\-max\-count
  80 Limit the number of commits output\&.
  81
  82 .TP
  83 \-\-max\-age=timestamp, \-\-min\-age=timestamp
  84 Limit the commits output to specified time range\&.
  85
  86 .TP
  87 \-\-sparse
  88 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\&.
  89
  90 .TP
  91 \-\-remove\-empty
  92 Stop when a given path disappears from the tree\&.
  93
  94 .TP
  95 \-\-all
  96 Pretend as if all the refs in $GIT_DIR/refs/ are listed on the command line as <commit>\&.
  97
  98 .TP
  99 \-\-topo\-order
 100 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)\&.
 101
 102 .TP
 103 \-\-merge\-order
 104 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\&.
 105
 106 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\&.
 107
 108 The merge order for a non\-linear epoch is defined as a linearisation for which the following invariants are true:
 109
 110 .RS
 111 .TP 3
 112 1.
 113 if a commit P is reachable from commit N, commit P sorts after commit N in the linearised list\&.
 114 .TP
 115 2.
 116 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\&.
 117
 118 Invariant 1 states that later commits appear before earlier commits they are derived from\&.
 119
 120 Invariant 2 states that commits unique to "later" parents in a merge, appear before all commits from "earlier" parents of a merge\&.
 121 .LP
 122 .RE
 123 .IP
 124
 125 .TP
 126 \-\-show\-breaks
 127 Each item of the list is output with a 2\-character prefix consisting of one of: (|), (^), (=) followed by a space\&.
 128
 129 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\&.
 130
 131 Commits marked with (|) are direct parents of commits immediately preceding the marked commit in the list\&.
 132
 133 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\&.
 134
 135 \-\-show\-breaks is only valid if \-\-merge\-order is also specified\&.
 136
 137 .SH "AUTHOR"
 138
 139
 140 Written by Linus Torvalds <torvalds@osdl\&.org>
 141
 142
 143 Original \fI\-\-merge\-order\fR logic by Jon Seymour <jon\&.seymour@gmail\&.com>
 144
 145 .SH "DOCUMENTATION"
 146
 147
 148 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 149
 150 .SH "GIT"
 151
 152
 153 Part of the \fBgit\fR(7) suite
 154