Merge branch 'tb/complete-describe' into maint
[git] / Documentation / git-rev-list.txt
1 git-rev-list(1)
2 ===============
3
4 NAME
5 ----
6 git-rev-list - Lists commit objects in reverse chronological order
7
8
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              [ --merges ]
18              [ --no-merges ]
19              [ --min-parents=<number> ]
20              [ --no-min-parents ]
21              [ --max-parents=<number> ]
22              [ --no-max-parents ]
23              [ --first-parent ]
24              [ --remove-empty ]
25              [ --full-history ]
26              [ --not ]
27              [ --all ]
28              [ --branches[=<pattern>] ]
29              [ --tags[=<pattern>] ]
30              [ --remotes[=<pattern>] ]
31              [ --glob=<glob-pattern> ]
32              [ --ignore-missing ]
33              [ --stdin ]
34              [ --quiet ]
35              [ --topo-order ]
36              [ --parents ]
37              [ --timestamp ]
38              [ --left-right ]
39              [ --left-only ]
40              [ --right-only ]
41              [ --cherry-mark ]
42              [ --cherry-pick ]
43              [ --encoding=<encoding> ]
44              [ --(author|committer|grep)=<pattern> ]
45              [ --regexp-ignore-case | -i ]
46              [ --extended-regexp | -E ]
47              [ --fixed-strings | -F ]
48              [ --date=<format>]
49              [ [ --objects | --objects-edge | --objects-edge-aggressive ]
50                [ --unpacked ] ]
51              [ --pretty | --header ]
52              [ --bisect ]
53              [ --bisect-vars ]
54              [ --bisect-all ]
55              [ --merge ]
56              [ --reverse ]
57              [ --walk-reflogs ]
58              [ --no-walk ] [ --do-walk ]
59              [ --count ]
60              [ --use-bitmap-index ]
61              <commit>... [ \-- <paths>... ]
62
63 DESCRIPTION
64 -----------
65
66 List commits that are reachable by following the `parent` links from the
67 given commit(s), but exclude commits that are reachable from the one(s)
68 given with a '{caret}' in front of them.  The output is given in reverse
69 chronological order by default.
70
71 You can think of this as a set operation.  Commits given on the command
72 line form a set of commits that are reachable from any of them, and then
73 commits reachable from any of the ones given with '{caret}' in front are
74 subtracted from that set.  The remaining commits are what comes out in the
75 command's output.  Various other options and paths parameters can be used
76 to further limit the result.
77
78 Thus, the following command:
79
80 -----------------------------------------------------------------------
81         $ git rev-list foo bar ^baz
82 -----------------------------------------------------------------------
83
84 means "list all the commits which are reachable from 'foo' or 'bar', but
85 not from 'baz'".
86
87 A special notation "'<commit1>'..'<commit2>'" can be used as a
88 short-hand for "{caret}'<commit1>' '<commit2>'". For example, either of
89 the following may be used interchangeably:
90
91 -----------------------------------------------------------------------
92         $ git rev-list origin..HEAD
93         $ git rev-list HEAD ^origin
94 -----------------------------------------------------------------------
95
96 Another special notation is "'<commit1>'...'<commit2>'" which is useful
97 for merges.  The resulting set of commits is the symmetric difference
98 between the two operands.  The following two commands are equivalent:
99
100 -----------------------------------------------------------------------
101         $ git rev-list A B --not $(git merge-base --all A B)
102         $ git rev-list A...B
103 -----------------------------------------------------------------------
104
105 'rev-list' is a very essential Git command, since it
106 provides the ability to build and traverse commit ancestry graphs. For
107 this reason, it has a lot of different options that enables it to be
108 used by commands as different as 'git bisect' and
109 'git repack'.
110
111 OPTIONS
112 -------
113
114 :git-rev-list: 1
115 include::rev-list-options.txt[]
116
117 include::pretty-formats.txt[]
118
119 GIT
120 ---
121 Part of the linkgit:git[1] suite