Merge branch 'sp/checkout'
[git/gitweb-caching.git] / Documentation / git-rev-list.txt
blob8255ae1bceee562140179704352a7e4f9cd83d99
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              [ \--max-age=timestamp ]
14              [ \--min-age=timestamp ]
15              [ \--sparse ]
16              [ \--no-merges ]
17              [ \--remove-empty ]
18              [ \--all ]
19              [ \--topo-order ]
20              [ \--parents ]
21              [ [\--objects | \--objects-edge] [ \--unpacked ] ]
22              [ \--pretty | \--header ]
23              [ \--bisect ]
24              <commit>... [ \-- <paths>... ]
26 DESCRIPTION
27 -----------
28 Lists commit objects in reverse chronological order starting at the
29 given commit(s), taking ancestry relationship into account.  This is
30 useful to produce human-readable log output.
32 Commits which are stated with a preceding '{caret}' cause listing to stop at
33 that point. Their parents are implied. "git-rev-list foo bar {caret}baz" thus
34 means "list all the commits which are included in 'foo' and 'bar', but
35 not in 'baz'".
37 A special notation <commit1>..<commit2> can be used as a
38 short-hand for {caret}<commit1> <commit2>.
41 OPTIONS
42 -------
43 --pretty::
44         Print the contents of the commit changesets in human-readable form.
46 --header::
47         Print the contents of the commit in raw-format; each
48         record is separated with a NUL character.
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'".
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.
64 --unpacked::
65         Only useful with `--objects`; print the object IDs that
66         are not in packs.
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
71         --bisect foo ^bar ^baz' outputs 'midpoint', the output
72         of 'git-rev-list foo ^midpoint' and 'git-rev-list midpoint
73         ^bar ^baz' would be of roughly the same length. Finding the change
74         which introduces a regression is thus reduced to a binary search:
75         repeatedly generate and test new 'midpoint's until the commit chain
76         is of length one.
78 --max-count::
79         Limit the number of commits output.
81 --max-age=timestamp, --min-age=timestamp::
82         Limit the commits output to specified time range.
84 --sparse::
85         When optional paths are given, the command outputs only
86         the commits that changes at least one of them, and also
87         ignores merges that do not touch the given paths.  This
88         flag makes the command output all eligible commits
89         (still subject to count and age limitation), but apply
90         merge simplification nevertheless.
92 --remove-empty::
93         Stop when a given path disappears from the tree.
95 --all::
96         Pretend as if all the refs in `$GIT_DIR/refs/` are
97         listed on the command line as <commit>.
99 --topo-order::
100         By default, the commits are shown in reverse
101         chronological order.  This option makes them appear in
102         topological order (i.e. descendant commits are shown
103         before their parents).
105 Author
106 ------
107 Written by Linus Torvalds <torvalds@osdl.org>
109 Documentation
110 --------------
111 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
115 Part of the gitlink:git[7] suite