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