summaryrefslogtreecommitdiff
path: root/Documentation/git-rev-list.txt
blob: 993911070a2ced38586b3aedcb5078f25d57ec35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
git-rev-list(1)
===============
 
NAME
----
git-rev-list - Lists commit objects in reverse chronological order
 
 
SYNOPSIS
--------
'git-rev-list' [ \--max-count=number ]
	[ \--max-age=timestamp ]
	[ \--min-age=timestamp ]
	[ \--sparse ]
	[ \--no-merges ]
	[ \--all ]
	[ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] | ]
	[ \--parents ]
	[ \--objects [ \--unpacked ] ]
	[ \--pretty | \--header | ]
	[ \--bisect ]
	<commit>... [ \-- <paths>... ]
 
DESCRIPTION
-----------
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.
 
Commits which are stated with a preceding '{caret}' cause listing to stop at
that point. Their parents are implied. "git-rev-list foo bar {caret}baz" thus
means "list all the commits which are included in 'foo' and 'bar', but
not in 'baz'".
 
A special notation <commit1>..<commit2> can be used as a
short-hand for {caret}<commit1> <commit2>.
 
 
OPTIONS
-------
--pretty::
	Print the contents of the commit changesets in human-readable form.
 
--header::
	Print the contents of the commit in raw-format; each
	record is separated with a NUL character.
 
--objects::
	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'".
 
--unpacked::
	Only useful with `--objects`; print the object IDs that
	are not in packs.
 
--bisect::
	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.
 
--max-count::
	Limit the number of commits output.
 
--max-age=timestamp, --min-age=timestamp::
	Limit the commits output to specified time range.
 
--sparse::
	When optional paths are given, the command outputs only
	the commits that changes at least one of them.  This
	flag makes the command ignore the paths, outputting all
	eligible commits (still subject to count and age
	limitation).
 
--all::
	Pretend as if all the refs in `$GIT_DIR/refs/` are
	listed on the command line as <commit>.
 
--topo-order::
	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).
 
--merge-order::
	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.
+
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
link:http://blackcubes.dyndns.org/epoch/[http://blackcubes.dyndns.org/epoch/].
+
The merge order for a non-linear epoch is defined as a linearisation for which
the following invariants are true:
+
    1. if a commit P is reachable from commit N, commit P sorts after commit N
       in the linearised list.
    2. 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.
+
Invariant 1 states that later commits appear before earlier commits they are
derived from.
+
Invariant 2 states that commits unique to "later" parents in a merge, appear
before all commits from "earlier" parents of a merge.
 
--show-breaks::
	Each item of the list is output with a 2-character prefix consisting
	of one of: (|), (^), (=) followed by a space.
+
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.
+
Commits marked with (|) are direct parents of commits immediately preceding
the marked commit in the list.
+
Commits marked with (^) are not parents of the immediately preceding commit.
These "breaks" represent necessary discontinuities implied by trying to
represent an arbtirary DAG in a linear form.
+
`--show-breaks` is only valid if `--merge-order` is also specified.
 
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
 
Original *--merge-order* logic by Jon Seymour <jon.seymour@gmail.com>
 
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the gitlink:git[7] suite