blob: c742117595cd8ae5ab371a7ba21513a419af7996 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231git-rev-list(1)
2===============
3
4NAME
5----
6git-rev-list - Lists commit objects in reverse chronological order
7
8
9SYNOPSIS
10--------
Junio C Hamano235a91e2006-01-07 01:13:5811[verse]
Junio C Hamano1a4e8412005-12-27 08:17:2312'git-rev-list' [ \--max-count=number ]
Junio C Hamano17bbaca2006-12-25 11:36:3113 [ \--skip=number ]
Junio C Hamano235a91e2006-01-07 01:13:5814 [ \--max-age=timestamp ]
15 [ \--min-age=timestamp ]
16 [ \--sparse ]
17 [ \--no-merges ]
Junio C Hamano9be18972006-01-28 08:54:5718 [ \--remove-empty ]
Junio C Hamano872c5682006-07-07 06:05:4019 [ \--not ]
Junio C Hamano235a91e2006-01-07 01:13:5820 [ \--all ]
Junio C Hamanoc9245d92006-09-06 09:35:4621 [ \--stdin ]
Junio C Hamanodecf50e2006-03-05 10:51:1422 [ \--topo-order ]
Junio C Hamano235a91e2006-01-07 01:13:5823 [ \--parents ]
Junio C Hamano775a0f42006-12-31 01:19:1424 [ \--encoding[=<encoding>] ]
Junio C Hamano47c1e3c2006-09-25 04:45:5525 [ \--(author|committer|grep)=<pattern> ]
Junio C Hamano5f327762006-03-02 09:14:5126 [ [\--objects | \--objects-edge] [ \--unpacked ] ]
Junio C Hamano235a91e2006-01-07 01:13:5827 [ \--pretty | \--header ]
28 [ \--bisect ]
Junio C Hamano859f3b42006-08-04 10:04:3029 [ \--merge ]
Junio C Hamanodb450ba2007-01-21 08:57:1430 [ \--walk-reflogs ]
Junio C Hamano235a91e2006-01-07 01:13:5831 <commit>... [ \-- <paths>... ]
Junio C Hamano1a4e8412005-12-27 08:17:2332
33DESCRIPTION
34-----------
Junio C Hamano89e135d2006-09-03 06:18:2535
Junio C Hamano1a4e8412005-12-27 08:17:2336Lists commit objects in reverse chronological order starting at the
37given commit(s), taking ancestry relationship into account. This is
38useful to produce human-readable log output.
39
Junio C Hamano89e135d2006-09-03 06:18:2540Commits which are stated with a preceding '{caret}' cause listing to
41stop at that point. Their parents are implied. Thus the following
42command:
43
44-----------------------------------------------------------------------
45$ git-rev-list foo bar ^baz
46-----------------------------------------------------------------------
47
Junio C Hamano1a4e8412005-12-27 08:17:2348means "list all the commits which are included in 'foo' and 'bar', but
49not in 'baz'".
50
Junio C Hamano89e135d2006-09-03 06:18:2551A special notation "'<commit1>'..'<commit2>'" can be used as a
52short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
53the following may be used interchangeably:
Junio C Hamano1a4e8412005-12-27 08:17:2354
Junio C Hamano89e135d2006-09-03 06:18:2555-----------------------------------------------------------------------
56$ git-rev-list origin..HEAD
57$ git-rev-list HEAD ^origin
58-----------------------------------------------------------------------
59
60Another special notation is "'<commit1>'...'<commit2>'" which is useful
61for merges. The resulting set of commits is the symmetric difference
Junio C Hamano872c5682006-07-07 06:05:4062between the two operands. The following two commands are equivalent:
63
Junio C Hamano89e135d2006-09-03 06:18:2564-----------------------------------------------------------------------
65$ git-rev-list A B --not $(git-merge-base --all A B)
66$ git-rev-list A...B
67-----------------------------------------------------------------------
68
69gitlink:git-rev-list[1] is a very essential git program, since it
70provides the ability to build and traverse commit ancestry graphs. For
71this reason, it has a lot of different options that enables it to be
72used by commands as different as gitlink:git-bisect[1] and
73gitlink:git-repack[1].
Junio C Hamano1a4e8412005-12-27 08:17:2374
75OPTIONS
76-------
Junio C Hamano89e135d2006-09-03 06:18:2577
78Commit Formatting
79~~~~~~~~~~~~~~~~~
80
81Using these options, gitlink:git-rev-list[1] will act similar to the
82more specialized family of commit log tools: gitlink:git-log[1],
83gitlink:git-show[1], and gitlink:git-whatchanged[1]
84
Junio C Hamanoa340aaa2006-11-23 02:47:3385include::pretty-formats.txt[]
Junio C Hamano89e135d2006-09-03 06:18:2586
87--relative-date::
88
89Show dates relative to the current time, e.g. "2 hours ago".
90Only takes effect for dates shown in human-readable format, such
91as when using "--pretty".
Junio C Hamano1a4e8412005-12-27 08:17:2392
93--header::
Junio C Hamano89e135d2006-09-03 06:18:2594
95Print the contents of the commit in raw-format; each record is
96separated with a NUL character.
Junio C Hamano1a4e8412005-12-27 08:17:2397
Junio C Hamano7ccb9fd2006-07-15 01:38:4098--parents::
Junio C Hamano89e135d2006-09-03 06:18:2599
Junio C Hamano7ccb9fd2006-07-15 01:38:40100Print the parents of the commit.
101
Junio C Hamano89e135d2006-09-03 06:18:25102Diff Formatting
103~~~~~~~~~~~~~~~
Junio C Hamano1a4e8412005-12-27 08:17:23104
Junio C Hamano89e135d2006-09-03 06:18:25105Below are listed options that control the formatting of diff output.
106Some of them are specific to gitlink:git-rev-list[1], however other diff
107options may be given. See gitlink:git-diff-files[1] for more options.
Junio C Hamano5f327762006-03-02 09:14:51108
Junio C Hamano89e135d2006-09-03 06:18:25109-c::
Junio C Hamano1a4e8412005-12-27 08:17:23110
Junio C Hamano89e135d2006-09-03 06:18:25111This flag changes the way a merge commit is displayed. It shows
112the differences from each of the parents to the merge result
113simultaneously instead of showing pairwise diff between a parent
114and the result one at a time. Furthermore, it lists only files
115which were modified from all parents.
Junio C Hamano1a4e8412005-12-27 08:17:23116
Junio C Hamano89e135d2006-09-03 06:18:25117--cc::
118
119This flag implies the '-c' options and further compresses the
120patch output by omitting hunks that show differences from only
121one parent, or show the same change from all but one parent for
122an Octopus merge.
123
124-r::
125
126Show recursive diffs.
127
128-t::
129
130Show the tree objects in the diff output. This implies '-r'.
131
132Commit Limiting
133~~~~~~~~~~~~~~~
134
135Besides specifying a range of commits that should be listed using the
136special notations explained in the description, additional commit
137limiting may be applied.
138
139--
140
141-n 'number', --max-count='number'::
142
Junio C Hamano1a4e8412005-12-27 08:17:23143Limit the number of commits output.
144
Junio C Hamano17bbaca2006-12-25 11:36:31145--skip='number'::
146
147Skip 'number' commits before starting to show the commit output.
148
Junio C Hamano89e135d2006-09-03 06:18:25149--since='date', --after='date'::
150
151Show commits more recent than a specific date.
152
153--until='date', --before='date'::
154
155Show commits older than a specific date.
156
157--max-age='timestamp', --min-age='timestamp'::
158
Junio C Hamano1a4e8412005-12-27 08:17:23159Limit the commits output to specified time range.
160
Junio C Hamano47c1e3c2006-09-25 04:45:55161--author='pattern', --committer='pattern'::
162
163Limit the commits output to ones with author/committer
164header lines that match the specified pattern.
165
166--grep='pattern'::
167
168Limit the commits output to ones with log message that
169matches the specified pattern.
170
Junio C Hamano9be18972006-01-28 08:54:57171--remove-empty::
Junio C Hamano89e135d2006-09-03 06:18:25172
Junio C Hamano9be18972006-01-28 08:54:57173Stop when a given path disappears from the tree.
174
Junio C Hamano7ccb9fd2006-07-15 01:38:40175--no-merges::
Junio C Hamano89e135d2006-09-03 06:18:25176
Junio C Hamano7ccb9fd2006-07-15 01:38:40177Do not print commits with more than one parent.
178
Junio C Hamano872c5682006-07-07 06:05:40179--not::
Junio C Hamano89e135d2006-09-03 06:18:25180
181Reverses the meaning of the '{caret}' prefix (or lack thereof)
182for all following revision specifiers, up to the next '--not'.
Junio C Hamano872c5682006-07-07 06:05:40183
Junio C Hamano1a4e8412005-12-27 08:17:23184--all::
Junio C Hamano1a4e8412005-12-27 08:17:23185
Junio C Hamano89e135d2006-09-03 06:18:25186Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
187command line as '<commit>'.
Junio C Hamano1a4e8412005-12-27 08:17:23188
Junio C Hamanoc9245d92006-09-06 09:35:46189--stdin::
190
191In addition to the '<commit>' listed on the command
192line, read them from the standard input.
193
Junio C Hamanofa0d4cf2007-01-25 02:23:58194-g, --walk-reflogs::
Junio C Hamanodb450ba2007-01-21 08:57:14195
196Instead of walking the commit ancestry chain, walk
197reflog entries from the most recent one to older ones.
198When this option is used you cannot specify commits to
199exclude (that is, '{caret}commit', 'commit1..commit2',
200nor 'commit1...commit2' notations cannot be used).
201+
202With '\--pretty' format other than oneline (for obvious reasons),
203this causes the output to have two extra lines of information
204taken from the reflog. By default, 'commit@{Nth}' notation is
205used in the output. When the starting commit is specified as
206'commit@{now}', output also uses 'commit@{timestamp}' notation
207instead. Under '\--pretty=oneline', the commit message is
208prefixed with this information on the same line.
209
Junio C Hamano859f3b42006-08-04 10:04:30210--merge::
Junio C Hamano89e135d2006-09-03 06:18:25211
Junio C Hamano859f3b42006-08-04 10:04:30212After a failed merge, show refs that touch files having a
213conflict and don't exist on all heads to merge.
214
Junio C Hamano89e135d2006-09-03 06:18:25215--boundary::
216
217Output uninteresting commits at the boundary, which are usually
218not shown.
219
220--dense, --sparse::
221
222When optional paths are given, the default behaviour ('--dense') is to
223only output commits that changes at least one of them, and also ignore
224merges that do not touch the given paths.
225
226Use the '--sparse' flag to makes the command output all eligible commits
227(still subject to count and age limitation), but apply merge
228simplification nevertheless.
229
230--bisect::
231
232Limit output to the one commit object which is roughly halfway between
233the included and excluded commits. Thus, if
234
235-----------------------------------------------------------------------
236$ git-rev-list --bisect foo ^bar ^baz
237-----------------------------------------------------------------------
238
239outputs 'midpoint', the output of the two commands
240
241-----------------------------------------------------------------------
242$ git-rev-list foo ^midpoint
243$ git-rev-list midpoint ^bar ^baz
244-----------------------------------------------------------------------
245
246would be of roughly the same length. Finding the change which
247introduces a regression is thus reduced to a binary search: repeatedly
248generate and test new 'midpoint's until the commit chain is of length
249one.
250
251--
252
253Commit Ordering
254~~~~~~~~~~~~~~~
255
256By default, the commits are shown in reverse chronological order.
257
258--topo-order::
259
260This option makes them appear in topological order (i.e.
261descendant commits are shown before their parents).
262
263--date-order::
264
265This option is similar to '--topo-order' in the sense that no
266parent comes before all of its children, but otherwise things
267are still ordered in the commit timestamp order.
268
269Object Traversal
270~~~~~~~~~~~~~~~~
271
272These options are mostly targeted for packing of git repositories.
273
274--objects::
275
276Print the object IDs of any object referenced by the listed
277commits. 'git-rev-list --objects foo ^bar' thus means "send me
278all object IDs which I need to download if I have the commit
279object 'bar', but not 'foo'".
280
281--objects-edge::
282
283Similar to '--objects', but also print the IDs of excluded
284commits prefixed with a "-" character. This is used by
285gitlink:git-pack-objects[1] to build "thin" pack, which records
286objects in deltified form based on objects contained in these
287excluded commits to reduce network traffic.
288
289--unpacked::
290
291Only useful with '--objects'; print the object IDs that are not
292in packs.
Junio C Hamanoa0778c92006-08-29 04:03:11293
Junio C Hamano1a4e8412005-12-27 08:17:23294Author
295------
296Written by Linus Torvalds <torvalds@osdl.org>
297
Junio C Hamano1a4e8412005-12-27 08:17:23298Documentation
299--------------
Junio C Hamano89e135d2006-09-03 06:18:25300Documentation by David Greaves, Junio C Hamano, Jonas Fonseca
301and the git-list <git@vger.kernel.org>.
Junio C Hamano1a4e8412005-12-27 08:17:23302
303GIT
304---
305Part of the gitlink:git[7] suite