blob: 20dcac625204869cf6c426d338f2fafd567368b9 [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 Hamanoee695f22007-06-21 00:35:3619 [ \--full-history ]
Junio C Hamano872c5682006-07-07 06:05:4020 [ \--not ]
Junio C Hamano235a91e2006-01-07 01:13:5821 [ \--all ]
Junio C Hamanoc9245d92006-09-06 09:35:4622 [ \--stdin ]
Junio C Hamanodecf50e2006-03-05 10:51:1423 [ \--topo-order ]
Junio C Hamano235a91e2006-01-07 01:13:5824 [ \--parents ]
Junio C Hamanoee695f22007-06-21 00:35:3625 [ \--timestamp ]
Junio C Hamano5678d692007-04-06 00:51:4326 [ \--left-right ]
Junio C Hamanod9e0e5d2007-04-14 16:22:0427 [ \--cherry-pick ]
Junio C Hamano775a0f42006-12-31 01:19:1428 [ \--encoding[=<encoding>] ]
Junio C Hamano47c1e3c2006-09-25 04:45:5529 [ \--(author|committer|grep)=<pattern> ]
Junio C Hamanoa5c02c52007-05-21 06:14:2730 [ \--regexp-ignore-case ] [ \--extended-regexp ]
Junio C Hamano45889b42007-04-26 07:20:0431 [ \--date={local|relative|default} ]
Junio C Hamano5f327762006-03-02 09:14:5132 [ [\--objects | \--objects-edge] [ \--unpacked ] ]
Junio C Hamano235a91e2006-01-07 01:13:5833 [ \--pretty | \--header ]
34 [ \--bisect ]
Junio C Hamano20f64da2007-04-04 18:38:3035 [ \--bisect-vars ]
Junio C Hamano859f3b42006-08-04 10:04:3036 [ \--merge ]
Junio C Hamano053827f2007-02-14 07:23:5837 [ \--reverse ]
Junio C Hamanodb450ba2007-01-21 08:57:1438 [ \--walk-reflogs ]
Junio C Hamano235a91e2006-01-07 01:13:5839 <commit>... [ \-- <paths>... ]
Junio C Hamano1a4e8412005-12-27 08:17:2340
41DESCRIPTION
42-----------
Junio C Hamano89e135d2006-09-03 06:18:2543
Junio C Hamano1a4e8412005-12-27 08:17:2344Lists commit objects in reverse chronological order starting at the
45given commit(s), taking ancestry relationship into account. This is
46useful to produce human-readable log output.
47
Junio C Hamano89e135d2006-09-03 06:18:2548Commits which are stated with a preceding '{caret}' cause listing to
49stop at that point. Their parents are implied. Thus the following
50command:
51
52-----------------------------------------------------------------------
53$ git-rev-list foo bar ^baz
54-----------------------------------------------------------------------
55
Junio C Hamano1a4e8412005-12-27 08:17:2356means "list all the commits which are included in 'foo' and 'bar', but
57not in 'baz'".
58
Junio C Hamano89e135d2006-09-03 06:18:2559A special notation "'<commit1>'..'<commit2>'" can be used as a
60short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
61the following may be used interchangeably:
Junio C Hamano1a4e8412005-12-27 08:17:2362
Junio C Hamano89e135d2006-09-03 06:18:2563-----------------------------------------------------------------------
64$ git-rev-list origin..HEAD
65$ git-rev-list HEAD ^origin
66-----------------------------------------------------------------------
67
68Another special notation is "'<commit1>'...'<commit2>'" which is useful
69for merges. The resulting set of commits is the symmetric difference
Junio C Hamano872c5682006-07-07 06:05:4070between the two operands. The following two commands are equivalent:
71
Junio C Hamano89e135d2006-09-03 06:18:2572-----------------------------------------------------------------------
73$ git-rev-list A B --not $(git-merge-base --all A B)
74$ git-rev-list A...B
75-----------------------------------------------------------------------
76
77gitlink:git-rev-list[1] is a very essential git program, since it
78provides the ability to build and traverse commit ancestry graphs. For
79this reason, it has a lot of different options that enables it to be
80used by commands as different as gitlink:git-bisect[1] and
81gitlink:git-repack[1].
Junio C Hamano1a4e8412005-12-27 08:17:2382
83OPTIONS
84-------
Junio C Hamano89e135d2006-09-03 06:18:2585
86Commit Formatting
87~~~~~~~~~~~~~~~~~
88
89Using these options, gitlink:git-rev-list[1] will act similar to the
90more specialized family of commit log tools: gitlink:git-log[1],
91gitlink:git-show[1], and gitlink:git-whatchanged[1]
92
Junio C Hamano0430e3a2007-05-15 03:13:1793include::pretty-options.txt[]
Junio C Hamano89e135d2006-09-03 06:18:2594
95--relative-date::
96
Junio C Hamano45889b42007-04-26 07:20:0497Synonym for `--date=relative`.
98
99--date={relative,local,default}::
100
Junio C Hamano89e135d2006-09-03 06:18:25101Only takes effect for dates shown in human-readable format, such
102as when using "--pretty".
Junio C Hamano45889b42007-04-26 07:20:04103+
104`--date=relative` shows dates relative to the current time,
105e.g. "2 hours ago".
106+
107`--date=local` shows timestamps in user's local timezone.
108+
109`--date=default` shows timestamps in the original timezone
110(either committer's or author's).
Junio C Hamano1a4e8412005-12-27 08:17:23111
112--header::
Junio C Hamano89e135d2006-09-03 06:18:25113
114Print the contents of the commit in raw-format; each record is
115separated with a NUL character.
Junio C Hamano1a4e8412005-12-27 08:17:23116
Junio C Hamano7ccb9fd2006-07-15 01:38:40117--parents::
Junio C Hamano89e135d2006-09-03 06:18:25118
Junio C Hamano7ccb9fd2006-07-15 01:38:40119Print the parents of the commit.
120
Junio C Hamanoee695f22007-06-21 00:35:36121--timestamp::
122Print the raw commit timestamp.
123
Junio C Hamano5678d692007-04-06 00:51:43124--left-right::
125
126Mark which side of a symmetric diff a commit is reachable from.
127Commits from the left side are prefixed with `<` and those from
128the right with `>`. If combined with `--boundary`, those
129commits are prefixed with `-`.
130+
131For example, if you have this topology:
132+
133-----------------------------------------------------------------------
134 y---b---b branch B
135 / \ /
136 / .
137 / / \
138 o---x---a---a branch A
139-----------------------------------------------------------------------
140+
141you would get an output line this:
142+
143-----------------------------------------------------------------------
144$ git rev-list --left-right --boundary --pretty=oneline A...B
145
146>bbbbbbb... 3rd on b
147>bbbbbbb... 2nd on b
148<aaaaaaa... 3rd on a
149<aaaaaaa... 2nd on a
150-yyyyyyy... 1st on b
151-xxxxxxx... 1st on a
152-----------------------------------------------------------------------
153
Junio C Hamano89e135d2006-09-03 06:18:25154Diff Formatting
155~~~~~~~~~~~~~~~
Junio C Hamano1a4e8412005-12-27 08:17:23156
Junio C Hamano89e135d2006-09-03 06:18:25157Below are listed options that control the formatting of diff output.
158Some of them are specific to gitlink:git-rev-list[1], however other diff
159options may be given. See gitlink:git-diff-files[1] for more options.
Junio C Hamano5f327762006-03-02 09:14:51160
Junio C Hamano89e135d2006-09-03 06:18:25161-c::
Junio C Hamano1a4e8412005-12-27 08:17:23162
Junio C Hamano89e135d2006-09-03 06:18:25163This flag changes the way a merge commit is displayed. It shows
164the differences from each of the parents to the merge result
165simultaneously instead of showing pairwise diff between a parent
166and the result one at a time. Furthermore, it lists only files
167which were modified from all parents.
Junio C Hamano1a4e8412005-12-27 08:17:23168
Junio C Hamano89e135d2006-09-03 06:18:25169--cc::
170
171This flag implies the '-c' options and further compresses the
172patch output by omitting hunks that show differences from only
173one parent, or show the same change from all but one parent for
174an Octopus merge.
175
176-r::
177
178Show recursive diffs.
179
180-t::
181
182Show the tree objects in the diff output. This implies '-r'.
183
184Commit Limiting
185~~~~~~~~~~~~~~~
186
187Besides specifying a range of commits that should be listed using the
188special notations explained in the description, additional commit
189limiting may be applied.
190
191--
192
193-n 'number', --max-count='number'::
194
Junio C Hamano1a4e8412005-12-27 08:17:23195Limit the number of commits output.
196
Junio C Hamano17bbaca2006-12-25 11:36:31197--skip='number'::
198
199Skip 'number' commits before starting to show the commit output.
200
Junio C Hamano89e135d2006-09-03 06:18:25201--since='date', --after='date'::
202
203Show commits more recent than a specific date.
204
205--until='date', --before='date'::
206
207Show commits older than a specific date.
208
209--max-age='timestamp', --min-age='timestamp'::
210
Junio C Hamano1a4e8412005-12-27 08:17:23211Limit the commits output to specified time range.
212
Junio C Hamano47c1e3c2006-09-25 04:45:55213--author='pattern', --committer='pattern'::
214
215Limit the commits output to ones with author/committer
Junio C Hamano75485c82007-05-19 04:20:33216header lines that match the specified pattern (regular expression).
Junio C Hamano47c1e3c2006-09-25 04:45:55217
218--grep='pattern'::
219
220Limit the commits output to ones with log message that
Junio C Hamano75485c82007-05-19 04:20:33221matches the specified pattern (regular expression).
Junio C Hamano47c1e3c2006-09-25 04:45:55222
Junio C Hamanoa5c02c52007-05-21 06:14:27223--regexp-ignore-case::
224
225Match the regexp limiting patterns without regard to letters case.
226
227--extended-regexp::
228
229Consider the limiting patterns to be extended regular expressions
230instead of the default basic regular expressions.
231
Junio C Hamano9be18972006-01-28 08:54:57232--remove-empty::
Junio C Hamano89e135d2006-09-03 06:18:25233
Junio C Hamano9be18972006-01-28 08:54:57234Stop when a given path disappears from the tree.
235
Junio C Hamanoee695f22007-06-21 00:35:36236--full-history::
237
238Show also parts of history irrelevant to current state of a given
239path. This turns off history simplification, which removed merges
240which didn't change anything at all at some child. It will still actually
241simplify away merges that didn't change anything at all into either
242child.
243
Junio C Hamano7ccb9fd2006-07-15 01:38:40244--no-merges::
Junio C Hamano89e135d2006-09-03 06:18:25245
Junio C Hamano7ccb9fd2006-07-15 01:38:40246Do not print commits with more than one parent.
247
Junio C Hamano872c5682006-07-07 06:05:40248--not::
Junio C Hamano89e135d2006-09-03 06:18:25249
250Reverses the meaning of the '{caret}' prefix (or lack thereof)
251for all following revision specifiers, up to the next '--not'.
Junio C Hamano872c5682006-07-07 06:05:40252
Junio C Hamano1a4e8412005-12-27 08:17:23253--all::
Junio C Hamano1a4e8412005-12-27 08:17:23254
Junio C Hamano89e135d2006-09-03 06:18:25255Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
256command line as '<commit>'.
Junio C Hamano1a4e8412005-12-27 08:17:23257
Junio C Hamanoc9245d92006-09-06 09:35:46258--stdin::
259
260In addition to the '<commit>' listed on the command
261line, read them from the standard input.
262
Junio C Hamanod9e0e5d2007-04-14 16:22:04263--cherry-pick::
264
265Omit any commit that introduces the same change as
266another commit on the "other side" when the set of
267commits are limited with symmetric difference.
268+
269For example, if you have two branches, `A` and `B`, a usual way
270to list all commits on only one side of them is with
271`--left-right`, like the example above in the description of
272that option. It however shows the commits that were cherry-picked
273from the other branch (for example, "3rd on b" may be cherry-picked
274from branch A). With this option, such pairs of commits are
275excluded from the output.
276
Junio C Hamanofa0d4cf2007-01-25 02:23:58277-g, --walk-reflogs::
Junio C Hamanodb450ba2007-01-21 08:57:14278
279Instead of walking the commit ancestry chain, walk
280reflog entries from the most recent one to older ones.
281When this option is used you cannot specify commits to
282exclude (that is, '{caret}commit', 'commit1..commit2',
283nor 'commit1...commit2' notations cannot be used).
284+
285With '\--pretty' format other than oneline (for obvious reasons),
286this causes the output to have two extra lines of information
Junio C Hamano1d90cb02007-07-03 07:05:31287taken from the reflog. By default, 'commit@\{Nth}' notation is
Junio C Hamanodb450ba2007-01-21 08:57:14288used in the output. When the starting commit is specified as
Junio C Hamano1d90cb02007-07-03 07:05:31289'commit@{now}', output also uses 'commit@\{timestamp}' notation
Junio C Hamanodb450ba2007-01-21 08:57:14290instead. Under '\--pretty=oneline', the commit message is
291prefixed with this information on the same line.
292
Junio C Hamano859f3b42006-08-04 10:04:30293--merge::
Junio C Hamano89e135d2006-09-03 06:18:25294
Junio C Hamano859f3b42006-08-04 10:04:30295After a failed merge, show refs that touch files having a
296conflict and don't exist on all heads to merge.
297
Junio C Hamano89e135d2006-09-03 06:18:25298--boundary::
299
300Output uninteresting commits at the boundary, which are usually
301not shown.
302
303--dense, --sparse::
304
305When optional paths are given, the default behaviour ('--dense') is to
306only output commits that changes at least one of them, and also ignore
307merges that do not touch the given paths.
308
309Use the '--sparse' flag to makes the command output all eligible commits
310(still subject to count and age limitation), but apply merge
311simplification nevertheless.
312
313--bisect::
314
315Limit output to the one commit object which is roughly halfway between
316the included and excluded commits. Thus, if
317
318-----------------------------------------------------------------------
319$ git-rev-list --bisect foo ^bar ^baz
320-----------------------------------------------------------------------
321
322outputs 'midpoint', the output of the two commands
323
324-----------------------------------------------------------------------
325$ git-rev-list foo ^midpoint
326$ git-rev-list midpoint ^bar ^baz
327-----------------------------------------------------------------------
328
329would be of roughly the same length. Finding the change which
330introduces a regression is thus reduced to a binary search: repeatedly
331generate and test new 'midpoint's until the commit chain is of length
332one.
333
Junio C Hamano20f64da2007-04-04 18:38:30334--bisect-vars::
335
336This calculates the same as `--bisect`, but outputs text ready
337to be eval'ed by the shell. These lines will assign the name of
338the midpoint revision to the variable `bisect_rev`, and the
339expected number of commits to be tested after `bisect_rev` is
340tested to `bisect_nr`, the expected number of commits to be
341tested if `bisect_rev` turns out to be good to `bisect_good`,
342the expected number of commits to be tested if `bisect_rev`
343turns out to be bad to `bisect_bad`, and the number of commits
344we are bisecting right now to `bisect_all`.
345
Junio C Hamano89e135d2006-09-03 06:18:25346--
347
348Commit Ordering
349~~~~~~~~~~~~~~~
350
351By default, the commits are shown in reverse chronological order.
352
353--topo-order::
354
355This option makes them appear in topological order (i.e.
356descendant commits are shown before their parents).
357
358--date-order::
359
360This option is similar to '--topo-order' in the sense that no
361parent comes before all of its children, but otherwise things
362are still ordered in the commit timestamp order.
363
Junio C Hamano053827f2007-02-14 07:23:58364--reverse::
365
366Output the commits in reverse order.
367
Junio C Hamano89e135d2006-09-03 06:18:25368Object Traversal
369~~~~~~~~~~~~~~~~
370
371These options are mostly targeted for packing of git repositories.
372
373--objects::
374
375Print the object IDs of any object referenced by the listed
376commits. 'git-rev-list --objects foo ^bar' thus means "send me
377all object IDs which I need to download if I have the commit
378object 'bar', but not 'foo'".
379
380--objects-edge::
381
382Similar to '--objects', but also print the IDs of excluded
383commits prefixed with a "-" character. This is used by
384gitlink:git-pack-objects[1] to build "thin" pack, which records
385objects in deltified form based on objects contained in these
386excluded commits to reduce network traffic.
387
388--unpacked::
389
390Only useful with '--objects'; print the object IDs that are not
391in packs.
Junio C Hamanoa0778c92006-08-29 04:03:11392
Junio C Hamano0430e3a2007-05-15 03:13:17393
394include::pretty-formats.txt[]
395
396
Junio C Hamano1a4e8412005-12-27 08:17:23397Author
398------
399Written by Linus Torvalds <torvalds@osdl.org>
400
Junio C Hamano1a4e8412005-12-27 08:17:23401Documentation
402--------------
Junio C Hamano89e135d2006-09-03 06:18:25403Documentation by David Greaves, Junio C Hamano, Jonas Fonseca
404and the git-list <git@vger.kernel.org>.
Junio C Hamano1a4e8412005-12-27 08:17:23405
406GIT
407---
408Part of the gitlink:git[7] suite