gitweb: Describe projects_index format in more detail
[git/jnareb-git/bp-gitweb.git] / Documentation / git-rev-list.txt
blobfd1de92e34b459cdc89928e1561ee6934cd63c19
1 git-rev-list(1)
2 ===============
4 NAME
5 ----
6 git-rev-list - Lists commit objects in reverse chronological order
9 SYNOPSIS
10 --------
11 [verse]
12 'git-rev-list' [ \--max-count=number ]
13              [ \--skip=number ]
14              [ \--max-age=timestamp ]
15              [ \--min-age=timestamp ]
16              [ \--sparse ]
17              [ \--no-merges ]
18              [ \--first-parent ]
19              [ \--remove-empty ]
20              [ \--full-history ]
21              [ \--not ]
22              [ \--all ]
23              [ \--branches ]
24              [ \--tags ]
25              [ \--remotes ]
26              [ \--stdin ]
27              [ \--quiet ]
28              [ \--topo-order ]
29              [ \--parents ]
30              [ \--timestamp ]
31              [ \--left-right ]
32              [ \--cherry-pick ]
33              [ \--encoding[=<encoding>] ]
34              [ \--(author|committer|grep)=<pattern> ]
35              [ \--regexp-ignore-case | \-i ]
36              [ \--extended-regexp | \-E ]
37              [ \--fixed-strings | \-F ]
38              [ \--date={local|relative|default|iso|rfc|short} ]
39              [ [\--objects | \--objects-edge] [ \--unpacked ] ]
40              [ \--pretty | \--header ]
41              [ \--bisect ]
42              [ \--bisect-vars ]
43              [ \--bisect-all ]
44              [ \--merge ]
45              [ \--reverse ]
46              [ \--walk-reflogs ]
47              [ \--no-walk ] [ \--do-walk ]
48              <commit>... [ \-- <paths>... ]
50 DESCRIPTION
51 -----------
53 Lists commit objects in reverse chronological order starting at the
54 given commit(s), taking ancestry relationship into account.  This is
55 useful to produce human-readable log output.
57 Commits which are stated with a preceding '{caret}' cause listing to
58 stop at that point. Their parents are implied. Thus the following
59 command:
61 -----------------------------------------------------------------------
62         $ git rev-list foo bar ^baz
63 -----------------------------------------------------------------------
65 means "list all the commits which are included in 'foo' and 'bar', but
66 not in 'baz'".
68 A special notation "'<commit1>'..'<commit2>'" can be used as a
69 short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
70 the following may be used interchangeably:
72 -----------------------------------------------------------------------
73         $ git rev-list origin..HEAD
74         $ git rev-list HEAD ^origin
75 -----------------------------------------------------------------------
77 Another special notation is "'<commit1>'...'<commit2>'" which is useful
78 for merges.  The resulting set of commits is the symmetric difference
79 between the two operands.  The following two commands are equivalent:
81 -----------------------------------------------------------------------
82         $ git rev-list A B --not $(git merge-base --all A B)
83         $ git rev-list A...B
84 -----------------------------------------------------------------------
86 'git-rev-list' is a very essential git program, since it
87 provides the ability to build and traverse commit ancestry graphs. For
88 this reason, it has a lot of different options that enables it to be
89 used by commands as different as 'git-bisect' and
90 'git-repack'.
92 OPTIONS
93 -------
95 :git-rev-list: 1
96 include::rev-list-options.txt[]
98 include::pretty-formats.txt[]
101 Author
102 ------
103 Written by Linus Torvalds <torvalds@osdl.org>
105 Documentation
106 --------------
107 Documentation by David Greaves, Junio C Hamano, Jonas Fonseca
108 and the git-list <git@vger.kernel.org>.
112 Part of the linkgit:git[1] suite