Merge branch 'maint'
[git/kirr.git] / Documentation / rev-list-options.txt
blob1d857559ef1327fd33dc5ab0f74e12fd9e3a3e26
1 Commit Formatting
2 ~~~~~~~~~~~~~~~~~
4 ifdef::git-rev-list[]
5 Using these options, linkgit:git-rev-list[1] will act similar to the
6 more specialized family of commit log tools: linkgit:git-log[1],
7 linkgit:git-show[1], and linkgit:git-whatchanged[1]
8 endif::git-rev-list[]
10 include::pretty-options.txt[]
12 --relative-date::
14         Synonym for `--date=relative`.
16 --date={relative,local,default,iso,rfc,short}::
18         Only takes effect for dates shown in human-readable format, such
19         as when using "--pretty". `log.date` config variable sets a default
20         value for log command's --date option.
22 `--date=relative` shows dates relative to the current time,
23 e.g. "2 hours ago".
25 `--date=local` shows timestamps in user's local timezone.
27 `--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
29 `--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
30 format, often found in E-mail messages.
32 `--date=short` shows only date but not time, in `YYYY-MM-DD` format.
34 `--date=default` shows timestamps in the original timezone
35 (either committer's or author's).
37 ifdef::git-rev-list[]
38 --header::
40         Print the contents of the commit in raw-format; each record is
41         separated with a NUL character.
42 endif::git-rev-list[]
44 --parents::
46         Print the parents of the commit.
48 --children::
50         Print the children of the commit.
52 ifdef::git-rev-list[]
53 --timestamp::
54         Print the raw commit timestamp.
55 endif::git-rev-list[]
57 --left-right::
59         Mark which side of a symmetric diff a commit is reachable from.
60         Commits from the left side are prefixed with `<` and those from
61         the right with `>`.  If combined with `--boundary`, those
62         commits are prefixed with `-`.
64 For example, if you have this topology:
66 -----------------------------------------------------------------------
67              y---b---b  branch B
68             / \ /
69            /   .
70           /   / \
71          o---x---a---a  branch A
72 -----------------------------------------------------------------------
74 you would get an output like this:
76 -----------------------------------------------------------------------
77         $ git rev-list --left-right --boundary --pretty=oneline A...B
79         >bbbbbbb... 3rd on b
80         >bbbbbbb... 2nd on b
81         <aaaaaaa... 3rd on a
82         <aaaaaaa... 2nd on a
83         -yyyyyyy... 1st on b
84         -xxxxxxx... 1st on a
85 -----------------------------------------------------------------------
87 --graph::
89         Draw a text-based graphical representation of the commit history
90         on the left hand side of the output.  This may cause extra lines
91         to be printed in between commits, in order for the graph history
92         to be drawn properly.
94 This implies the '--topo-order' option by default, but the
95 '--date-order' option may also be specified.
97 Diff Formatting
98 ~~~~~~~~~~~~~~~
100 Below are listed options that control the formatting of diff output.
101 Some of them are specific to linkgit:git-rev-list[1], however other diff
102 options may be given. See linkgit:git-diff-files[1] for more options.
104 -c::
106         This flag changes the way a merge commit is displayed.  It shows
107         the differences from each of the parents to the merge result
108         simultaneously instead of showing pairwise diff between a parent
109         and the result one at a time. Furthermore, it lists only files
110         which were modified from all parents.
112 --cc::
114         This flag implies the '-c' options and further compresses the
115         patch output by omitting uninteresting hunks whose contents in
116         the parents have only two variants and the merge result picks
117         one of them without modification.
119 -r::
121         Show recursive diffs.
123 -t::
125         Show the tree objects in the diff output. This implies '-r'.
127 Commit Limiting
128 ~~~~~~~~~~~~~~~
130 Besides specifying a range of commits that should be listed using the
131 special notations explained in the description, additional commit
132 limiting may be applied.
136 -n 'number'::
137 --max-count='number'::
139         Limit the number of commits output.
141 --skip='number'::
143         Skip 'number' commits before starting to show the commit output.
145 --since='date'::
146 --after='date'::
148         Show commits more recent than a specific date.
150 --until='date'::
151 --before='date'::
153         Show commits older than a specific date.
155 ifdef::git-rev-list[]
156 --max-age='timestamp'::
157 --min-age='timestamp'::
159         Limit the commits output to specified time range.
160 endif::git-rev-list[]
162 --author='pattern'::
163 --committer='pattern'::
165         Limit the commits output to ones with author/committer
166         header lines that match the specified pattern (regular expression).
168 --grep='pattern'::
170         Limit the commits output to ones with log message that
171         matches the specified pattern (regular expression).
173 -i::
174 --regexp-ignore-case::
176         Match the regexp limiting patterns without regard to letters case.
178 -E::
179 --extended-regexp::
181         Consider the limiting patterns to be extended regular expressions
182         instead of the default basic regular expressions.
184 -F::
185 --fixed-strings::
187         Consider the limiting patterns to be fixed strings (don't interpret
188         pattern as a regular expression).
190 --remove-empty::
192         Stop when a given path disappears from the tree.
194 --full-history::
196         Show also parts of history irrelevant to current state of a given
197         path. This turns off history simplification, which removed merges
198         which didn't change anything at all at some child. It will still actually
199         simplify away merges that didn't change anything at all into either
200         child.
202 --no-merges::
204         Do not print commits with more than one parent.
206 --first-parent::
207         Follow only the first parent commit upon seeing a merge
208         commit.  This option can give a better overview when
209         viewing the evolution of a particular topic branch,
210         because merges into a topic branch tend to be only about
211         adjusting to updated upstream from time to time, and
212         this option allows you to ignore the individual commits
213         brought in to your history by such a merge.
215 --not::
217         Reverses the meaning of the '{caret}' prefix (or lack thereof)
218         for all following revision specifiers, up to the next '--not'.
220 --all::
222         Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
223         command line as '<commit>'.
225 ifdef::git-rev-list[]
226 --stdin::
228         In addition to the '<commit>' listed on the command
229         line, read them from the standard input.
231 --quiet::
233         Don't print anything to standard output.  This form
234         is primarily meant to allow the caller to
235         test the exit status to see if a range of objects is fully
236         connected (or not).  It is faster than redirecting stdout
237         to /dev/null as the output does not have to be formatted.
238 endif::git-rev-list[]
240 --cherry-pick::
242         Omit any commit that introduces the same change as
243         another commit on the "other side" when the set of
244         commits are limited with symmetric difference.
246 For example, if you have two branches, `A` and `B`, a usual way
247 to list all commits on only one side of them is with
248 `--left-right`, like the example above in the description of
249 that option.  It however shows the commits that were cherry-picked
250 from the other branch (for example, "3rd on b" may be cherry-picked
251 from branch A).  With this option, such pairs of commits are
252 excluded from the output.
254 -g::
255 --walk-reflogs::
257         Instead of walking the commit ancestry chain, walk
258         reflog entries from the most recent one to older ones.
259         When this option is used you cannot specify commits to
260         exclude (that is, '{caret}commit', 'commit1..commit2',
261         nor 'commit1...commit2' notations cannot be used).
263 With '\--pretty' format other than oneline (for obvious reasons),
264 this causes the output to have two extra lines of information
265 taken from the reflog.  By default, 'commit@\{Nth}' notation is
266 used in the output.  When the starting commit is specified as
267 'commit@\{now}', output also uses 'commit@\{timestamp}' notation
268 instead.  Under '\--pretty=oneline', the commit message is
269 prefixed with this information on the same line.
270 This option cannot be combined with '\--reverse'.
271 See also linkgit:git-reflog[1].
273 --merge::
275         After a failed merge, show refs that touch files having a
276         conflict and don't exist on all heads to merge.
278 --boundary::
280         Output uninteresting commits at the boundary, which are usually
281         not shown.
283 --dense::
284 --sparse::
286 When optional paths are given, the default behaviour ('--dense') is to
287 only output commits that changes at least one of them, and also ignore
288 merges that do not touch the given paths.
290 Use the '--sparse' flag to makes the command output all eligible commits
291 (still subject to count and age limitation), but apply merge
292 simplification nevertheless.
294 ifdef::git-rev-list[]
295 --bisect::
297 Limit output to the one commit object which is roughly halfway between
298 the included and excluded commits. Thus, if
300 -----------------------------------------------------------------------
301         $ git-rev-list --bisect foo ^bar ^baz
302 -----------------------------------------------------------------------
304 outputs 'midpoint', the output of the two commands
306 -----------------------------------------------------------------------
307         $ git-rev-list foo ^midpoint
308         $ git-rev-list midpoint ^bar ^baz
309 -----------------------------------------------------------------------
311 would be of roughly the same length.  Finding the change which
312 introduces a regression is thus reduced to a binary search: repeatedly
313 generate and test new 'midpoint's until the commit chain is of length
314 one.
316 --bisect-vars::
318 This calculates the same as `--bisect`, but outputs text ready
319 to be eval'ed by the shell. These lines will assign the name of
320 the midpoint revision to the variable `bisect_rev`, and the
321 expected number of commits to be tested after `bisect_rev` is
322 tested to `bisect_nr`, the expected number of commits to be
323 tested if `bisect_rev` turns out to be good to `bisect_good`,
324 the expected number of commits to be tested if `bisect_rev`
325 turns out to be bad to `bisect_bad`, and the number of commits
326 we are bisecting right now to `bisect_all`.
328 --bisect-all::
330 This outputs all the commit objects between the included and excluded
331 commits, ordered by their distance to the included and excluded
332 commits. The farthest from them is displayed first. (This is the only
333 one displayed by `--bisect`.)
335 This is useful because it makes it easy to choose a good commit to
336 test when you want to avoid to test some of them for some reason (they
337 may not compile for example).
339 This option can be used along with `--bisect-vars`, in this case,
340 after all the sorted commit objects, there will be the same text as if
341 `--bisect-vars` had been used alone.
342 endif::git-rev-list[]
346 Commit Ordering
347 ~~~~~~~~~~~~~~~
349 By default, the commits are shown in reverse chronological order.
351 --topo-order::
353         This option makes them appear in topological order (i.e.
354         descendant commits are shown before their parents).
356 --date-order::
358         This option is similar to '--topo-order' in the sense that no
359         parent comes before all of its children, but otherwise things
360         are still ordered in the commit timestamp order.
362 --reverse::
364         Output the commits in reverse order.
365         Cannot be combined with '\--walk-reflogs'.
367 Object Traversal
368 ~~~~~~~~~~~~~~~~
370 These options are mostly targeted for packing of git repositories.
372 --objects::
374         Print the object IDs of any object referenced by the listed
375         commits.  '--objects foo ^bar' thus means "send me
376         all object IDs which I need to download if I have the commit
377         object 'bar', but not 'foo'".
379 --objects-edge::
381         Similar to '--objects', but also print the IDs of excluded
382         commits prefixed with a "-" character.  This is used by
383         linkgit:git-pack-objects[1] to build "thin" pack, which records
384         objects in deltified form based on objects contained in these
385         excluded commits to reduce network traffic.
387 --unpacked::
389         Only useful with '--objects'; print the object IDs that are not
390         in packs.
392 --no-walk::
394         Only show the given revs, but do not traverse their ancestors.
396 --do-walk::
398         Overrides a previous --no-walk.