log --grep: use the same helper to set -E/-F options as "git grep"
[git/git.git] / Documentation / rev-list-options.txt
CommitLineData
fdcf39e5
MV
1Commit Limiting
2~~~~~~~~~~~~~~~
3
4Besides specifying a range of commits that should be listed using the
5special notations explained in the description, additional commit
a23e3138
JH
6limiting may be applied.
7
8Using more options generally further limits the output (e.g.
9`--since=<date1>` limits to commits newer than `<date1>`, and using it
10with `--grep=<pattern>` further limits to commits whose log message
11has a line that matches `<pattern>`), unless otherwise noted.
12
13Note that these are applied before commit
14ordering and formatting options, such as `--reverse`.
fdcf39e5
MV
15
16--
17
70c2a258
NTND
18-<number>::
19-n <number>::
982962ce 20--max-count=<number>::
fdcf39e5 21
841d8118 22 Limit the number of commits to output.
fdcf39e5 23
982962ce 24--skip=<number>::
fdcf39e5
MV
25
26 Skip 'number' commits before starting to show the commit output.
27
982962ce
MM
28--since=<date>::
29--after=<date>::
fdcf39e5
MV
30
31 Show commits more recent than a specific date.
32
982962ce
MM
33--until=<date>::
34--before=<date>::
fdcf39e5
MV
35
36 Show commits older than a specific date.
37
56b6d01d 38ifdef::git-rev-list[]
982962ce
MM
39--max-age=<timestamp>::
40--min-age=<timestamp>::
fdcf39e5
MV
41
42 Limit the commits output to specified time range.
56b6d01d 43endif::git-rev-list[]
fdcf39e5 44
982962ce
MM
45--author=<pattern>::
46--committer=<pattern>::
fdcf39e5
MV
47
48 Limit the commits output to ones with author/committer
a23e3138
JH
49 header lines that match the specified pattern (regular
50 expression). With more than one `--author=<pattern>`,
51 commits whose author matches any of the given patterns are
52 chosen (similarly for multiple `--committer=<pattern>`).
fdcf39e5 53
72fd13f7
NTND
54--grep-reflog=<pattern>::
55
56 Limit the commits output to ones with reflog entries that
57 match the specified pattern (regular expression). With
58 more than one `--grep-reflog`, commits whose reflog message
baa6378f
JH
59 matches any of the given patterns are chosen. It is an
60 error to use this option unless `--walk-reflogs` is in use.
72fd13f7 61
982962ce 62--grep=<pattern>::
fdcf39e5
MV
63
64 Limit the commits output to ones with log message that
a23e3138
JH
65 matches the specified pattern (regular expression). With
66 more than one `--grep=<pattern>`, commits whose message
67 matches any of the given patterns are chosen (but see
68 `--all-match`).
38cfe915
NTND
69+
70When `--show-notes` is in effect, the message from the notes as
71if it is part of the log message.
fdcf39e5 72
7756ba74
MM
73--all-match::
74 Limit the commits output to ones that match all given --grep,
a23e3138 75 instead of ones that match at least one.
7756ba74 76
3240240f
SB
77-i::
78--regexp-ignore-case::
fdcf39e5
MV
79
80 Match the regexp limiting patterns without regard to letters case.
81
3240240f
SB
82-E::
83--extended-regexp::
fdcf39e5
MV
84
85 Consider the limiting patterns to be extended regular expressions
86 instead of the default basic regular expressions.
87
3240240f
SB
88-F::
89--fixed-strings::
dc1c0fff
JN
90
91 Consider the limiting patterns to be fixed strings (don't interpret
92 pattern as a regular expression).
93
fdcf39e5
MV
94--remove-empty::
95
96 Stop when a given path disappears from the tree.
97
2657420d
SG
98--merges::
99
6a6ebded 100 Print only merge commits. This is exactly the same as `--min-parents=2`.
2657420d 101
fdcf39e5
MV
102--no-merges::
103
6a6ebded
MG
104 Do not print commits with more than one parent. This is
105 exactly the same as `--max-parents=1`.
106
107--min-parents=<number>::
108--max-parents=<number>::
109--no-min-parents::
110--no-max-parents::
111
112 Show only commits which have at least (or at most) that many
113 commits. In particular, `--max-parents=1` is the same as `--no-merges`,
114 `--min-parents=2` is the same as `--merges`. `--max-parents=0`
115 gives all root commits and `--min-parents=3` all octopus merges.
116+
117`--no-min-parents` and `--no-max-parents` reset these limits (to no limit)
118again. Equivalent forms are `--min-parents=0` (any commit has 0 or more
119parents) and `--max-parents=-1` (negative numbers denote no upper limit).
fdcf39e5
MV
120
121--first-parent::
122 Follow only the first parent commit upon seeing a merge
123 commit. This option can give a better overview when
124 viewing the evolution of a particular topic branch,
125 because merges into a topic branch tend to be only about
126 adjusting to updated upstream from time to time, and
127 this option allows you to ignore the individual commits
128 brought in to your history by such a merge.
129
130--not::
131
132 Reverses the meaning of the '{caret}' prefix (or lack thereof)
133 for all following revision specifiers, up to the next '--not'.
134
135--all::
136
cc1b8d8b 137 Pretend as if all the refs in `refs/` are listed on the
fdcf39e5 138 command line as '<commit>'.
c2e6385d 139
62b4698e 140--branches[=<pattern>]::
c2e6385d 141
cc1b8d8b 142 Pretend as if all the refs in `refs/heads` are listed
62b4698e 143 on the command line as '<commit>'. If '<pattern>' is given, limit
b09fe971 144 branches to ones matching given shell glob. If pattern lacks '?',
e34bb2e7 145 '{asterisk}', or '[', '/{asterisk}' at the end is implied.
c2e6385d 146
62b4698e 147--tags[=<pattern>]::
c2e6385d 148
cc1b8d8b 149 Pretend as if all the refs in `refs/tags` are listed
62b4698e 150 on the command line as '<commit>'. If '<pattern>' is given, limit
e34bb2e7
CMN
151 tags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',
152 or '[', '/{asterisk}' at the end is implied.
c2e6385d 153
62b4698e 154--remotes[=<pattern>]::
c2e6385d 155
cc1b8d8b 156 Pretend as if all the refs in `refs/remotes` are listed
62b4698e 157 on the command line as '<commit>'. If '<pattern>' is given, limit
0e615b25 158 remote-tracking branches to ones matching given shell glob.
e34bb2e7 159 If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied.
fdcf39e5 160
62b4698e
ŠN
161--glob=<glob-pattern>::
162 Pretend as if all the refs matching shell glob '<glob-pattern>'
d08bae7e 163 are listed on the command line as '<commit>'. Leading 'refs/',
e34bb2e7
CMN
164 is automatically prepended if missing. If pattern lacks '?', '{asterisk}',
165 or '[', '/{asterisk}' at the end is implied.
d08bae7e 166
cc243c3c
JH
167--ignore-missing::
168
169 Upon seeing an invalid object name in the input, pretend as if
170 the bad input was not given.
d08bae7e 171
af06e93a
CC
172ifndef::git-rev-list[]
173--bisect::
174
cc1b8d8b 175 Pretend as if the bad bisection ref `refs/bisect/bad`
af06e93a 176 was listed and as if it was followed by `--not` and the good
cc1b8d8b 177 bisection refs `refs/bisect/good-*` on the command
af06e93a
CC
178 line.
179endif::git-rev-list[]
180
fdcf39e5
MV
181--stdin::
182
183 In addition to the '<commit>' listed on the command
60da8b15
JH
184 line, read them from the standard input. If a '--' separator is
185 seen, stop reading commits and start reading paths to limit the
186 result.
fdcf39e5 187
8b3dce56 188ifdef::git-rev-list[]
fdcf39e5
MV
189--quiet::
190
191 Don't print anything to standard output. This form
192 is primarily meant to allow the caller to
193 test the exit status to see if a range of objects is fully
194 connected (or not). It is faster than redirecting stdout
195 to /dev/null as the output does not have to be formatted.
adf60f14 196endif::git-rev-list[]
fdcf39e5 197
cb56e309
MG
198--cherry-mark::
199
200 Like `--cherry-pick` (see below) but mark equivalent commits
201 with `=` rather than omitting them, and inequivalent ones with `+`.
202
fdcf39e5
MV
203--cherry-pick::
204
205 Omit any commit that introduces the same change as
206 another commit on the "other side" when the set of
207 commits are limited with symmetric difference.
208+
209For example, if you have two branches, `A` and `B`, a usual way
210to list all commits on only one side of them is with
3add01bb
JH
211`--left-right` (see the example below in the description of
212the `--left-right` option). It however shows the commits that were cherry-picked
fdcf39e5
MV
213from the other branch (for example, "3rd on b" may be cherry-picked
214from branch A). With this option, such pairs of commits are
215excluded from the output.
216
59c8afdf
MG
217--left-only::
218--right-only::
219
220 List only commits on the respective side of a symmetric range,
221 i.e. only those which would be marked `<` resp. `>` by
222 `--left-right`.
223+
224For example, `--cherry-pick --right-only A...B` omits those
225commits from `B` which are in `A` or are patch-equivalent to a commit in
6cf378f0 226`A`. In other words, this lists the `+` commits from `git cherry A B`.
59c8afdf
MG
227More precisely, `--cherry-pick --right-only --no-merges` gives the exact
228list.
229
94f605ec
MG
230--cherry::
231
232 A synonym for `--right-only --cherry-mark --no-merges`; useful to
233 limit the output to the commits on our side and mark those that
234 have been applied to the other side of a forked history with
235 `git log --cherry upstream...mybranch`, similar to
236 `git cherry upstream mybranch`.
237
3240240f
SB
238-g::
239--walk-reflogs::
fdcf39e5
MV
240
241 Instead of walking the commit ancestry chain, walk
242 reflog entries from the most recent one to older ones.
243 When this option is used you cannot specify commits to
244 exclude (that is, '{caret}commit', 'commit1..commit2',
b9190e79 245 nor 'commit1\...commit2' notations cannot be used).
fdcf39e5
MV
246+
247With '\--pretty' format other than oneline (for obvious reasons),
248this causes the output to have two extra lines of information
249taken from the reflog. By default, 'commit@\{Nth}' notation is
250used in the output. When the starting commit is specified as
18a2197e 251'commit@\{now}', output also uses 'commit@\{timestamp}' notation
fdcf39e5
MV
252instead. Under '\--pretty=oneline', the commit message is
253prefixed with this information on the same line.
e534735a 254This option cannot be combined with '\--reverse'.
fdcf39e5
MV
255See also linkgit:git-reflog[1].
256
257--merge::
258
259 After a failed merge, show refs that touch files having a
260 conflict and don't exist on all heads to merge.
261
262--boundary::
263
264 Output uninteresting commits at the boundary, which are usually
265 not shown.
266
70d9895e
TR
267--
268
269History Simplification
270~~~~~~~~~~~~~~~~~~~~~~
271
7bc2508b
SB
272Sometimes you are only interested in parts of the history, for example the
273commits modifying a particular <path>. But there are two parts of
274'History Simplification', one part is selecting the commits and the other
275is how to do it, as there are various strategies to simplify the history.
276
277The following options select the commits to be shown:
278
279<paths>::
280
281 Commits modifying the given <paths> are selected.
282
283--simplify-by-decoration::
284
285 Commits that are referred by some branch or tag are selected.
286
287Note that extra commits can be shown to give a meaningful history.
288
289The following options affect the way the simplification is performed:
290
291Default mode::
292
293 Simplifies the history to the simplest history explaining the
294 final state of the tree. Simplest because it prunes some side
295 branches if the end result is the same (i.e. merging branches
296 with the same content)
297
298--full-history::
299
df6b0cad 300 Same as the default mode, but does not prune some history.
7bc2508b
SB
301
302--dense::
303
304 Only the selected commits are shown, plus some to have a
305 meaningful history.
306
307--sparse::
308
309 All commits in the simplified history are shown.
310
311--simplify-merges::
312
313 Additional option to '--full-history' to remove some needless
314 merges from the resulting history, as there are no selected
315 commits contributing to this merge.
316
57456ef4
JH
317--ancestry-path::
318
319 When given a range of commits to display (e.g. 'commit1..commit2'
320 or 'commit2 {caret}commit1'), only display commits that exist
321 directly on the ancestry chain between the 'commit1' and
322 'commit2', i.e. commits that are both descendants of 'commit1',
323 and ancestors of 'commit2'.
324
7bc2508b 325A more detailed explanation follows.
70d9895e
TR
326
327Suppose you specified `foo` as the <paths>. We shall call commits
328that modify `foo` !TREESAME, and the rest TREESAME. (In a diff
329filtered for `foo`, they look different and equal, respectively.)
330
331In the following, we will always refer to the same example history to
332illustrate the differences between simplification settings. We assume
333that you are filtering for a file `foo` in this commit graph:
334-----------------------------------------------------------------------
335 .-A---M---N---O---P
336 / / / / /
337 I B C D E
338 \ / / / /
339 `-------------'
340-----------------------------------------------------------------------
565e135a 341The horizontal line of history A---P is taken to be the first parent of
70d9895e
TR
342each merge. The commits are:
343
344* `I` is the initial commit, in which `foo` exists with contents
345 "asdf", and a file `quux` exists with contents "quux". Initial
346 commits are compared to an empty tree, so `I` is !TREESAME.
347
348* In `A`, `foo` contains just "foo".
349
350* `B` contains the same change as `A`. Its merge `M` is trivial and
351 hence TREESAME to all parents.
352
353* `C` does not change `foo`, but its merge `N` changes it to "foobar",
354 so it is not TREESAME to any parent.
355
356* `D` sets `foo` to "baz". Its merge `O` combines the strings from
357 `N` and `D` to "foobarbaz"; i.e., it is not TREESAME to any parent.
358
359* `E` changes `quux` to "xyzzy", and its merge `P` combines the
360 strings to "quux xyzzy". Despite appearing interesting, `P` is
361 TREESAME to all parents.
362
363'rev-list' walks backwards through history, including or excluding
364commits based on whether '\--full-history' and/or parent rewriting
365(via '\--parents' or '\--children') are used. The following settings
366are available.
367
368Default mode::
369
370 Commits are included if they are not TREESAME to any parent
371 (though this can be changed, see '\--sparse' below). If the
372 commit was a merge, and it was TREESAME to one parent, follow
373 only that parent. (Even if there are several TREESAME
374 parents, follow only one of them.) Otherwise, follow all
375 parents.
376+
377This results in:
378+
379-----------------------------------------------------------------------
380 .-A---N---O
f70d0586 381 / / /
70d9895e
TR
382 I---------D
383-----------------------------------------------------------------------
384+
385Note how the rule to only follow the TREESAME parent, if one is
386available, removed `B` from consideration entirely. `C` was
387considered via `N`, but is TREESAME. Root commits are compared to an
388empty tree, so `I` is !TREESAME.
389+
390Parent/child relations are only visible with --parents, but that does
391not affect the commits selected in default mode, so we have shown the
392parent lines.
393
394--full-history without parent rewriting::
395
396 This mode differs from the default in one point: always follow
397 all parents of a merge, even if it is TREESAME to one of them.
398 Even if more than one side of the merge has commits that are
399 included, this does not imply that the merge itself is! In
400 the example, we get
401+
402-----------------------------------------------------------------------
403 I A B N D O
404-----------------------------------------------------------------------
405+
406`P` and `M` were excluded because they are TREESAME to a parent. `E`,
407`C` and `B` were all walked, but only `B` was !TREESAME, so the others
408do not appear.
409+
410Note that without parent rewriting, it is not really possible to talk
411about the parent/child relationships between the commits, so we show
412them disconnected.
413
414--full-history with parent rewriting::
415
416 Ordinary commits are only included if they are !TREESAME
417 (though this can be changed, see '\--sparse' below).
418+
419Merges are always included. However, their parent list is rewritten:
420Along each parent, prune away commits that are not included
421themselves. This results in
422+
423-----------------------------------------------------------------------
424 .-A---M---N---O---P
425 / / / / /
426 I B / D /
427 \ / / / /
428 `-------------'
429-----------------------------------------------------------------------
430+
431Compare to '\--full-history' without rewriting above. Note that `E`
432was pruned away because it is TREESAME, but the parent list of P was
433rewritten to contain `E`'s parent `I`. The same happened for `C` and
434`N`. Note also that `P` was included despite being TREESAME.
435
436In addition to the above settings, you can change whether TREESAME
437affects inclusion:
438
3240240f 439--dense::
70d9895e
TR
440
441 Commits that are walked are included if they are not TREESAME
442 to any parent.
443
3240240f 444--sparse::
fdcf39e5 445
70d9895e
TR
446 All commits that are walked are included.
447+
448Note that without '\--full-history', this still simplifies merges: if
449one of the parents is TREESAME, we follow only that one, so the other
450sides of the merge are never walked.
fdcf39e5 451
d266a988
TR
452--simplify-merges::
453
454 First, build a history graph in the same way that
455 '\--full-history' with parent rewriting does (see above).
456+
457Then simplify each commit `C` to its replacement `C'` in the final
458history according to the following rules:
459+
460--
461* Set `C'` to `C`.
462+
463* Replace each parent `P` of `C'` with its simplification `P'`. In
464 the process, drop parents that are ancestors of other parents, and
465 remove duplicates.
466+
467* If after this parent rewriting, `C'` is a root or merge commit (has
468 zero or >1 parents), a boundary commit, or !TREESAME, it remains.
469 Otherwise, it is replaced with its only parent.
470--
471+
472The effect of this is best shown by way of comparing to
473'\--full-history' with parent rewriting. The example turns into:
474+
475-----------------------------------------------------------------------
476 .-A---M---N---O
477 / / /
478 I B D
479 \ / /
480 `---------'
481-----------------------------------------------------------------------
482+
6cf378f0 483Note the major differences in `N` and `P` over '--full-history':
d266a988
TR
484+
485--
486* `N`'s parent list had `I` removed, because it is an ancestor of the
487 other parent `M`. Still, `N` remained because it is !TREESAME.
488+
489* `P`'s parent list similarly had `I` removed. `P` was then
490 removed completely, because it had one parent and is TREESAME.
491--
fdcf39e5 492
57456ef4
JH
493Finally, there is a fifth simplification mode available:
494
495--ancestry-path::
496
497 Limit the displayed commits to those directly on the ancestry
498 chain between the "from" and "to" commits in the given commit
499 range. I.e. only display commits that are ancestor of the "to"
500 commit, and descendants of the "from" commit.
501+
502As an example use case, consider the following commit history:
503+
504-----------------------------------------------------------------------
505 D---E-------F
506 / \ \
507 B---C---G---H---I---J
508 / \
509 A-------K---------------L--M
510-----------------------------------------------------------------------
511+
512A regular 'D..M' computes the set of commits that are ancestors of `M`,
513but excludes the ones that are ancestors of `D`. This is useful to see
514what happened to the history leading to `M` since `D`, in the sense
515that "what does `M` have that did not exist in `D`". The result in this
516example would be all the commits, except `A` and `B` (and `D` itself,
517of course).
518+
519When we want to find out what commits in `M` are contaminated with the
520bug introduced by `D` and need fixing, however, we might want to view
521only the subset of 'D..M' that are actually descendants of `D`, i.e.
6cf378f0 522excluding `C` and `K`. This is exactly what the '--ancestry-path'
57456ef4
JH
523option does. Applied to the 'D..M' range, it results in:
524+
525-----------------------------------------------------------------------
526 E-------F
527 \ \
528 G---H---I---J
529 \
530 L--M
531-----------------------------------------------------------------------
532
3fcfd662
NS
533The '\--simplify-by-decoration' option allows you to view only the
534big picture of the topology of the history, by omitting commits
535that are not referenced by tags. Commits are marked as !TREESAME
536(in other words, kept after history simplification rules described
537above) if (1) they are referenced by tags, or (2) they change the
538contents of the paths given on the command line. All other
539commits are marked as TREESAME (subject to be simplified away).
540
fdcf39e5 541ifdef::git-rev-list[]
70d9895e
TR
542Bisection Helpers
543~~~~~~~~~~~~~~~~~
544
fdcf39e5
MV
545--bisect::
546
547Limit output to the one commit object which is roughly halfway between
af06e93a 548included and excluded commits. Note that the bad bisection ref
cc1b8d8b
JK
549`refs/bisect/bad` is added to the included commits (if it
550exists) and the good bisection refs `refs/bisect/good-*` are
af06e93a 551added to the excluded commits (if they exist). Thus, supposing there
cc1b8d8b 552are no refs in `refs/bisect/`, if
fdcf39e5
MV
553
554-----------------------------------------------------------------------
6514aa36 555 $ git rev-list --bisect foo ^bar ^baz
fdcf39e5
MV
556-----------------------------------------------------------------------
557
558outputs 'midpoint', the output of the two commands
559
560-----------------------------------------------------------------------
6514aa36
CC
561 $ git rev-list foo ^midpoint
562 $ git rev-list midpoint ^bar ^baz
fdcf39e5
MV
563-----------------------------------------------------------------------
564
565would be of roughly the same length. Finding the change which
566introduces a regression is thus reduced to a binary search: repeatedly
567generate and test new 'midpoint's until the commit chain is of length
568one.
569
570--bisect-vars::
571
af06e93a 572This calculates the same as `--bisect`, except that refs in
cc1b8d8b 573`refs/bisect/` are not used, and except that this outputs
af06e93a
CC
574text ready to be eval'ed by the shell. These lines will assign the
575name of the midpoint revision to the variable `bisect_rev`, and the
576expected number of commits to be tested after `bisect_rev` is tested
577to `bisect_nr`, the expected number of commits to be tested if
578`bisect_rev` turns out to be good to `bisect_good`, the expected
579number of commits to be tested if `bisect_rev` turns out to be bad to
580`bisect_bad`, and the number of commits we are bisecting right now to
581`bisect_all`.
fdcf39e5
MV
582
583--bisect-all::
584
585This outputs all the commit objects between the included and excluded
586commits, ordered by their distance to the included and excluded
cc1b8d8b 587commits. Refs in `refs/bisect/` are not used. The farthest
af06e93a
CC
588from them is displayed first. (This is the only one displayed by
589`--bisect`.)
3d2d4f96 590+
fdcf39e5
MV
591This is useful because it makes it easy to choose a good commit to
592test when you want to avoid to test some of them for some reason (they
593may not compile for example).
3d2d4f96 594+
fdcf39e5
MV
595This option can be used along with `--bisect-vars`, in this case,
596after all the sorted commit objects, there will be the same text as if
597`--bisect-vars` had been used alone.
598endif::git-rev-list[]
599
fdcf39e5
MV
600
601Commit Ordering
602~~~~~~~~~~~~~~~
603
604By default, the commits are shown in reverse chronological order.
605
3f0350cc
JH
606--date-order::
607 Show no parents before all of its children are shown, but
608 otherwise show commits in the commit timestamp order.
fdcf39e5 609
3f0350cc
JH
610--topo-order::
611 Show no parents before all of its children are shown, and
612 avoid showing commits on multiple lines of history
613 intermixed.
614+
615For example, in a commit history like this:
616+
617----------------------------------------------------------------
fdcf39e5 618
3f0350cc
JH
619 ---1----2----4----7
620 \ \
621 3----5----6----8---
fdcf39e5 622
3f0350cc
JH
623----------------------------------------------------------------
624+
625where the numbers denote the order of commit timestamps, `git
626rev-list` and friends with `--date-order` show the commits in the
627timestamp order: 8 7 6 5 4 3 2 1.
628+
629With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
6303 1); some older commits are shown before newer ones in order to
631avoid showing the commits from two parallel development track mixed
632together.
fdcf39e5
MV
633
634--reverse::
635
636 Output the commits in reverse order.
637 Cannot be combined with '\--walk-reflogs'.
638
639Object Traversal
640~~~~~~~~~~~~~~~~
641
642These options are mostly targeted for packing of git repositories.
643
644--objects::
645
646 Print the object IDs of any object referenced by the listed
647 commits. '--objects foo ^bar' thus means "send me
648 all object IDs which I need to download if I have the commit
649 object 'bar', but not 'foo'".
650
651--objects-edge::
652
653 Similar to '--objects', but also print the IDs of excluded
654 commits prefixed with a "-" character. This is used by
655 linkgit:git-pack-objects[1] to build "thin" pack, which records
656 objects in deltified form based on objects contained in these
657 excluded commits to reduce network traffic.
658
659--unpacked::
660
661 Only useful with '--objects'; print the object IDs that are not
662 in packs.
663
ca92e59e
MZ
664--no-walk[=(sorted|unsorted)]::
665
666 Only show the given commits, but do not traverse their ancestors.
667 This has no effect if a range is specified. If the argument
668 "unsorted" is given, the commits are show in the order they were
669 given on the command line. Otherwise (if "sorted" or no argument
670 was given), the commits are show in reverse chronological order
671 by commit time.
fdcf39e5
MV
672
673--do-walk::
674
675 Overrides a previous --no-walk.
f98fd436
MG
676
677Commit Formatting
678~~~~~~~~~~~~~~~~~
679
680ifdef::git-rev-list[]
681Using these options, linkgit:git-rev-list[1] will act similar to the
682more specialized family of commit log tools: linkgit:git-log[1],
683linkgit:git-show[1], and linkgit:git-whatchanged[1]
684endif::git-rev-list[]
685
686include::pretty-options.txt[]
687
688--relative-date::
689
690 Synonym for `--date=relative`.
691
692--date=(relative|local|default|iso|rfc|short|raw)::
693
694 Only takes effect for dates shown in human-readable format, such
695 as when using "--pretty". `log.date` config variable sets a default
696 value for log command's --date option.
697+
698`--date=relative` shows dates relative to the current time,
699e.g. "2 hours ago".
700+
701`--date=local` shows timestamps in user's local timezone.
702+
703`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
704+
705`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
706format, often found in E-mail messages.
707+
708`--date=short` shows only date but not time, in `YYYY-MM-DD` format.
709+
710`--date=raw` shows the date in the internal raw git format `%s %z` format.
711+
712`--date=default` shows timestamps in the original timezone
713(either committer's or author's).
714
715ifdef::git-rev-list[]
716--header::
717
718 Print the contents of the commit in raw-format; each record is
719 separated with a NUL character.
720endif::git-rev-list[]
721
722--parents::
723
724 Print also the parents of the commit (in the form "commit parent...").
725 Also enables parent rewriting, see 'History Simplification' below.
726
727--children::
728
729 Print also the children of the commit (in the form "commit child...").
730 Also enables parent rewriting, see 'History Simplification' below.
731
732ifdef::git-rev-list[]
733--timestamp::
734 Print the raw commit timestamp.
735endif::git-rev-list[]
736
737--left-right::
738
739 Mark which side of a symmetric diff a commit is reachable from.
740 Commits from the left side are prefixed with `<` and those from
741 the right with `>`. If combined with `--boundary`, those
742 commits are prefixed with `-`.
743+
744For example, if you have this topology:
745+
746-----------------------------------------------------------------------
747 y---b---b branch B
748 / \ /
749 / .
750 / / \
751 o---x---a---a branch A
752-----------------------------------------------------------------------
753+
754you would get an output like this:
755+
756-----------------------------------------------------------------------
757 $ git rev-list --left-right --boundary --pretty=oneline A...B
758
759 >bbbbbbb... 3rd on b
760 >bbbbbbb... 2nd on b
761 <aaaaaaa... 3rd on a
762 <aaaaaaa... 2nd on a
763 -yyyyyyy... 1st on b
764 -xxxxxxx... 1st on a
765-----------------------------------------------------------------------
766
767--graph::
768
769 Draw a text-based graphical representation of the commit history
770 on the left hand side of the output. This may cause extra lines
771 to be printed in between commits, in order for the graph history
772 to be drawn properly.
773+
774This enables parent rewriting, see 'History Simplification' below.
775+
776This implies the '--topo-order' option by default, but the
777'--date-order' option may also be specified.
778
779ifdef::git-rev-list[]
780--count::
781 Print a number stating how many commits would have been
782 listed, and suppress all other output. When used together
783 with '--left-right', instead print the counts for left and
b388e14b
MG
784 right commits, separated by a tab. When used together with
785 '--cherry-mark', omit patch equivalent commits from these
786 counts and print the count for equivalent commits separated
787 by a tab.
f98fd436
MG
788endif::git-rev-list[]
789
790
791ifndef::git-rev-list[]
792Diff Formatting
793~~~~~~~~~~~~~~~
794
795Below are listed options that control the formatting of diff output.
796Some of them are specific to linkgit:git-rev-list[1], however other diff
797options may be given. See linkgit:git-diff-files[1] for more options.
798
799-c::
800
801 With this option, diff output for a merge commit
802 shows the differences from each of the parents to the merge result
803 simultaneously instead of showing pairwise diff between a parent
804 and the result one at a time. Furthermore, it lists only files
805 which were modified from all parents.
806
807--cc::
808
edfbbf7e 809 This flag implies the '-c' option and further compresses the
f98fd436
MG
810 patch output by omitting uninteresting hunks whose contents in
811 the parents have only two variants and the merge result picks
812 one of them without modification.
813
814-m::
815
816 This flag makes the merge commits show the full diff like
817 regular commits; for each merge parent, a separate log entry
818 and diff is generated. An exception is that only diff against
819 the first parent is shown when '--first-parent' option is given;
820 in that case, the output represents the changes the merge
821 brought _into_ the then-current branch.
822
823-r::
824
825 Show recursive diffs.
826
827-t::
828
829 Show the tree objects in the diff output. This implies '-r'.
830
831-s::
832 Suppress diff output.
833endif::git-rev-list[]