Add get_merge_bases_clean()
[git/git.git] / Documentation / git-rev-list.txt
CommitLineData
2cf565c5
DG
1git-rev-list(1)
2===============
2cf565c5
DG
3
4NAME
5----
6git-rev-list - Lists commit objects in reverse chronological order
7
8
9SYNOPSIS
10--------
353ce815 11[verse]
69e0c256 12'git-rev-list' [ \--max-count=number ]
353ce815
JF
13 [ \--max-age=timestamp ]
14 [ \--min-age=timestamp ]
15 [ \--sparse ]
16 [ \--no-merges ]
93b74bca 17 [ \--remove-empty ]
353ce815 18 [ \--all ]
765ac8ec 19 [ \--topo-order ]
353ce815 20 [ \--parents ]
ec579767 21 [ [\--objects | \--objects-edge] [ \--unpacked ] ]
353ce815
JF
22 [ \--pretty | \--header ]
23 [ \--bisect ]
24 <commit>... [ \-- <paths>... ]
2cf565c5
DG
25
26DESCRIPTION
27-----------
28Lists commit objects in reverse chronological order starting at the
adcd3512 29given commit(s), taking ancestry relationship into account. This is
2cf565c5
DG
30useful to produce human-readable log output.
31
69e0c256
JH
32Commits which are stated with a preceding '{caret}' cause listing to stop at
33that point. Their parents are implied. "git-rev-list foo bar {caret}baz" thus
adcd3512
MU
34means "list all the commits which are included in 'foo' and 'bar', but
35not in 'baz'".
36
69e0c256
JH
37A special notation <commit1>..<commit2> can be used as a
38short-hand for {caret}<commit1> <commit2>.
39
40
df8baa42
JF
41OPTIONS
42-------
43--pretty::
44 Print the contents of the commit changesets in human-readable form.
45
69e0c256
JH
46--header::
47 Print the contents of the commit in raw-format; each
48 record is separated with a NUL character.
49
df8baa42
JF
50--objects::
51 Print the object IDs of any object referenced by the listed commits.
52 'git-rev-list --objects foo ^bar' thus means "send me all object IDs
53 which I need to download if I have the commit object 'bar', but
54 not 'foo'".
55
ec579767
JH
56--objects-edge::
57 Similar to `--objects`, but also print the IDs of
58 excluded commits refixed with a `-` character. This is
59 used by `git-pack-objects` to build 'thin' pack, which
60 records objects in deltified form based on objects
61 contained in these excluded commits to reduce network
62 traffic.
63
69e0c256
JH
64--unpacked::
65 Only useful with `--objects`; print the object IDs that
66 are not in packs.
67
df8baa42
JF
68--bisect::
69 Limit output to the one commit object which is roughly halfway
70 between the included and excluded commits. Thus, if 'git-rev-list
afb4ff20
JH
71 --bisect foo {caret}bar {caret}baz' outputs 'midpoint', the output
72 of 'git-rev-list foo {caret}midpoint' and 'git-rev-list midpoint
73 {caret}bar {caret}baz' would be of roughly the same length.
74 Finding the change
df8baa42
JF
75 which introduces a regression is thus reduced to a binary search:
76 repeatedly generate and test new 'midpoint's until the commit chain
77 is of length one.
78
69e0c256
JH
79--max-count::
80 Limit the number of commits output.
81
82--max-age=timestamp, --min-age=timestamp::
83 Limit the commits output to specified time range.
84
85--sparse::
86 When optional paths are given, the command outputs only
64b1f6e6
JH
87 the commits that changes at least one of them, and also
88 ignores merges that do not touch the given paths. This
89 flag makes the command output all eligible commits
90 (still subject to count and age limitation), but apply
91 merge simplification nevertheless.
69e0c256 92
93b74bca
JH
93--remove-empty::
94 Stop when a given path disappears from the tree.
95
69e0c256
JH
96--all::
97 Pretend as if all the refs in `$GIT_DIR/refs/` are
98 listed on the command line as <commit>.
99
100--topo-order::
101 By default, the commits are shown in reverse
102 chronological order. This option makes them appear in
103 topological order (i.e. descendant commits are shown
104 before their parents).
105
2cf565c5
DG
106Author
107------
108Written by Linus Torvalds <torvalds@osdl.org>
109
110Documentation
111--------------
112Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
113
114GIT
115---
a7154e91 116Part of the gitlink:git[7] suite
2cf565c5 117