Documentation: update descriptions of revision options related to '--bisect'
[git/dscho.git] / Documentation / rev-list-options.txt
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,raw}::
18         Only takes effect for dates shown in human-readable format, such
19         as when using "--pretty". `` 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=raw` shows the date in the internal raw git format `%s %z` format.
36 `--date=default` shows timestamps in the original timezone
37 (either committer's or author's).
39 ifdef::git-rev-list[]
40 --header::
42         Print the contents of the commit in raw-format; each record is
43         separated with a NUL character.
44 endif::git-rev-list[]
46 --parents::
48         Print the parents of the commit.  Also enables parent
49         rewriting, see 'History Simplification' below.
51 --children::
53         Print the children of the commit.  Also enables parent
54         rewriting, see 'History Simplification' below.
56 ifdef::git-rev-list[]
57 --timestamp::
58         Print the raw commit timestamp.
59 endif::git-rev-list[]
61 --left-right::
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 `-`.
68 For example, if you have this topology:
70 -----------------------------------------------------------------------
71              y---b---b  branch B
72             / \ /
73            /   .
74           /   / \
75          o---x---a---a  branch A
76 -----------------------------------------------------------------------
78 you would get an output like this:
80 -----------------------------------------------------------------------
81         $ git rev-list --left-right --boundary --pretty=oneline A...B
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 -----------------------------------------------------------------------
91 --graph::
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.
98 This implies the '--topo-order' option by default, but the
99 '--date-order' option may also be specified.
101 ifndef::git-rev-list[]
102 Diff Formatting
103 ~~~~~~~~~~~~~~~
105 Below are listed options that control the formatting of diff output.
106 Some of them are specific to linkgit:git-rev-list[1], however other diff
107 options may be given. See linkgit:git-diff-files[1] for more options.
109 -c::
111         This flag changes the way a merge commit is displayed.  It shows
112         the differences from each of the parents to the merge result
113         simultaneously instead of showing pairwise diff between a parent
114         and the result one at a time. Furthermore, it lists only files
115         which were modified from all parents.
117 --cc::
119         This flag implies the '-c' options and further compresses the
120         patch output by omitting uninteresting hunks whose contents in
121         the parents have only two variants and the merge result picks
122         one of them without modification.
124 -r::
126         Show recursive diffs.
128 -t::
130         Show the tree objects in the diff output. This implies '-r'.
131 endif::git-rev-list[]
133 Commit Limiting
134 ~~~~~~~~~~~~~~~
136 Besides specifying a range of commits that should be listed using the
137 special notations explained in the description, additional commit
138 limiting may be applied.
142 -n 'number'::
143 --max-count=<number>::
145         Limit the number of commits output.
147 --skip=<number>::
149         Skip 'number' commits before starting to show the commit output.
151 --since=<date>::
152 --after=<date>::
154         Show commits more recent than a specific date.
156 --until=<date>::
157 --before=<date>::
159         Show commits older than a specific date.
161 ifdef::git-rev-list[]
162 --max-age=<timestamp>::
163 --min-age=<timestamp>::
165         Limit the commits output to specified time range.
166 endif::git-rev-list[]
168 --author=<pattern>::
169 --committer=<pattern>::
171         Limit the commits output to ones with author/committer
172         header lines that match the specified pattern (regular expression).
174 --grep=<pattern>::
176         Limit the commits output to ones with log message that
177         matches the specified pattern (regular expression).
179 --all-match::
180         Limit the commits output to ones that match all given --grep,
181         --author and --committer instead of ones that match at least one.
183 -i::
184 --regexp-ignore-case::
186         Match the regexp limiting patterns without regard to letters case.
188 -E::
189 --extended-regexp::
191         Consider the limiting patterns to be extended regular expressions
192         instead of the default basic regular expressions.
194 -F::
195 --fixed-strings::
197         Consider the limiting patterns to be fixed strings (don't interpret
198         pattern as a regular expression).
200 --remove-empty::
202         Stop when a given path disappears from the tree.
204 --merges::
206         Print only merge commits.
208 --no-merges::
210         Do not print commits with more than one parent.
212 --first-parent::
213         Follow only the first parent commit upon seeing a merge
214         commit.  This option can give a better overview when
215         viewing the evolution of a particular topic branch,
216         because merges into a topic branch tend to be only about
217         adjusting to updated upstream from time to time, and
218         this option allows you to ignore the individual commits
219         brought in to your history by such a merge.
221 --not::
223         Reverses the meaning of the '{caret}' prefix (or lack thereof)
224         for all following revision specifiers, up to the next '--not'.
226 --all::
228         Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
229         command line as '<commit>'.
231 --branches::
233         Pretend as if all the refs in `$GIT_DIR/refs/heads` are listed
234         on the command line as '<commit>'.
236 --tags::
238         Pretend as if all the refs in `$GIT_DIR/refs/tags` are listed
239         on the command line as '<commit>'.
241 --remotes::
243         Pretend as if all the refs in `$GIT_DIR/refs/remotes` are listed
244         on the command line as '<commit>'.
246 ifndef::git-rev-list[]
247 --bisect::
249         Pretend as if the bad bisection ref `$GIT_DIR/refs/bisect/bad`
250         was listed and as if it was followed by `--not` and the good
251         bisection refs `$GIT_DIR/refs/bisect/good-*` on the command
252         line.
253 endif::git-rev-list[]
255 --stdin::
257         In addition to the '<commit>' listed on the command
258         line, read them from the standard input. If a '--' separator is
259         seen, stop reading commits and start reading paths to limit the
260         result.
262 ifdef::git-rev-list[]
263 --quiet::
265         Don't print anything to standard output.  This form
266         is primarily meant to allow the caller to
267         test the exit status to see if a range of objects is fully
268         connected (or not).  It is faster than redirecting stdout
269         to /dev/null as the output does not have to be formatted.
270 endif::git-rev-list[]
272 --cherry-pick::
274         Omit any commit that introduces the same change as
275         another commit on the "other side" when the set of
276         commits are limited with symmetric difference.
278 For example, if you have two branches, `A` and `B`, a usual way
279 to list all commits on only one side of them is with
280 `--left-right`, like the example above in the description of
281 that option.  It however shows the commits that were cherry-picked
282 from the other branch (for example, "3rd on b" may be cherry-picked
283 from branch A).  With this option, such pairs of commits are
284 excluded from the output.
286 -g::
287 --walk-reflogs::
289         Instead of walking the commit ancestry chain, walk
290         reflog entries from the most recent one to older ones.
291         When this option is used you cannot specify commits to
292         exclude (that is, '{caret}commit', 'commit1..commit2',
293         nor 'commit1...commit2' notations cannot be used).
295 With '\--pretty' format other than oneline (for obvious reasons),
296 this causes the output to have two extra lines of information
297 taken from the reflog.  By default, 'commit@\{Nth}' notation is
298 used in the output.  When the starting commit is specified as
299 'commit@\{now}', output also uses 'commit@\{timestamp}' notation
300 instead.  Under '\--pretty=oneline', the commit message is
301 prefixed with this information on the same line.
302 This option cannot be combined with '\--reverse'.
303 See also linkgit:git-reflog[1].
305 --merge::
307         After a failed merge, show refs that touch files having a
308         conflict and don't exist on all heads to merge.
310 --boundary::
312         Output uninteresting commits at the boundary, which are usually
313         not shown.
317 History Simplification
318 ~~~~~~~~~~~~~~~~~~~~~~
320 Sometimes you are only interested in parts of the history, for example the
321 commits modifying a particular <path>. But there are two parts of
322 'History Simplification', one part is selecting the commits and the other
323 is how to do it, as there are various strategies to simplify the history.
325 The following options select the commits to be shown:
327 <paths>::
329         Commits modifying the given <paths> are selected.
331 --simplify-by-decoration::
333         Commits that are referred by some branch or tag are selected.
335 Note that extra commits can be shown to give a meaningful history.
337 The following options affect the way the simplification is performed:
339 Default mode::
341         Simplifies the history to the simplest history explaining the
342         final state of the tree. Simplest because it prunes some side
343         branches if the end result is the same (i.e. merging branches
344         with the same content)
346 --full-history::
348         As the default mode but does not prune some history.
350 --dense::
352         Only the selected commits are shown, plus some to have a
353         meaningful history.
355 --sparse::
357         All commits in the simplified history are shown.
359 --simplify-merges::
361         Additional option to '--full-history' to remove some needless
362         merges from the resulting history, as there are no selected
363         commits contributing to this merge.
365 A more detailed explanation follows.
367 Suppose you specified `foo` as the <paths>.  We shall call commits
368 that modify `foo` !TREESAME, and the rest TREESAME.  (In a diff
369 filtered for `foo`, they look different and equal, respectively.)
371 In the following, we will always refer to the same example history to
372 illustrate the differences between simplification settings.  We assume
373 that you are filtering for a file `foo` in this commit graph:
374 -----------------------------------------------------------------------
375           .-A---M---N---O---P
376          /     /   /   /   /
377         I     B   C   D   E
378          \   /   /   /   /
379           `-------------'
380 -----------------------------------------------------------------------
381 The horizontal line of history A--P is taken to be the first parent of
382 each merge.  The commits are:
384 * `I` is the initial commit, in which `foo` exists with contents
385   "asdf", and a file `quux` exists with contents "quux".  Initial
386   commits are compared to an empty tree, so `I` is !TREESAME.
388 * In `A`, `foo` contains just "foo".
390 * `B` contains the same change as `A`.  Its merge `M` is trivial and
391   hence TREESAME to all parents.
393 * `C` does not change `foo`, but its merge `N` changes it to "foobar",
394   so it is not TREESAME to any parent.
396 * `D` sets `foo` to "baz".  Its merge `O` combines the strings from
397   `N` and `D` to "foobarbaz"; i.e., it is not TREESAME to any parent.
399 * `E` changes `quux` to "xyzzy", and its merge `P` combines the
400   strings to "quux xyzzy".  Despite appearing interesting, `P` is
401   TREESAME to all parents.
403 'rev-list' walks backwards through history, including or excluding
404 commits based on whether '\--full-history' and/or parent rewriting
405 (via '\--parents' or '\--children') are used.  The following settings
406 are available.
408 Default mode::
410         Commits are included if they are not TREESAME to any parent
411         (though this can be changed, see '\--sparse' below).  If the
412         commit was a merge, and it was TREESAME to one parent, follow
413         only that parent.  (Even if there are several TREESAME
414         parents, follow only one of them.)  Otherwise, follow all
415         parents.
417 This results in:
419 -----------------------------------------------------------------------
420           .-A---N---O
421          /         /
422         I---------D
423 -----------------------------------------------------------------------
425 Note how the rule to only follow the TREESAME parent, if one is
426 available, removed `B` from consideration entirely.  `C` was
427 considered via `N`, but is TREESAME.  Root commits are compared to an
428 empty tree, so `I` is !TREESAME.
430 Parent/child relations are only visible with --parents, but that does
431 not affect the commits selected in default mode, so we have shown the
432 parent lines.
434 --full-history without parent rewriting::
436         This mode differs from the default in one point: always follow
437         all parents of a merge, even if it is TREESAME to one of them.
438         Even if more than one side of the merge has commits that are
439         included, this does not imply that the merge itself is!  In
440         the example, we get
442 -----------------------------------------------------------------------
443         I  A  B  N  D  O
444 -----------------------------------------------------------------------
446 `P` and `M` were excluded because they are TREESAME to a parent.  `E`,
447 `C` and `B` were all walked, but only `B` was !TREESAME, so the others
448 do not appear.
450 Note that without parent rewriting, it is not really possible to talk
451 about the parent/child relationships between the commits, so we show
452 them disconnected.
454 --full-history with parent rewriting::
456         Ordinary commits are only included if they are !TREESAME
457         (though this can be changed, see '\--sparse' below).
459 Merges are always included.  However, their parent list is rewritten:
460 Along each parent, prune away commits that are not included
461 themselves.  This results in
463 -----------------------------------------------------------------------
464           .-A---M---N---O---P
465          /     /   /   /   /
466         I     B   /   D   /
467          \   /   /   /   /
468           `-------------'
469 -----------------------------------------------------------------------
471 Compare to '\--full-history' without rewriting above.  Note that `E`
472 was pruned away because it is TREESAME, but the parent list of P was
473 rewritten to contain `E`'s parent `I`.  The same happened for `C` and
474 `N`.  Note also that `P` was included despite being TREESAME.
476 In addition to the above settings, you can change whether TREESAME
477 affects inclusion:
479 --dense::
481         Commits that are walked are included if they are not TREESAME
482         to any parent.
484 --sparse::
486         All commits that are walked are included.
488 Note that without '\--full-history', this still simplifies merges: if
489 one of the parents is TREESAME, we follow only that one, so the other
490 sides of the merge are never walked.
492 Finally, there is a fourth simplification mode available:
494 --simplify-merges::
496         First, build a history graph in the same way that
497         '\--full-history' with parent rewriting does (see above).
499 Then simplify each commit `C` to its replacement `C'` in the final
500 history according to the following rules:
503 * Set `C'` to `C`.
505 * Replace each parent `P` of `C'` with its simplification `P'`.  In
506   the process, drop parents that are ancestors of other parents, and
507   remove duplicates.
509 * If after this parent rewriting, `C'` is a root or merge commit (has
510   zero or >1 parents), a boundary commit, or !TREESAME, it remains.
511   Otherwise, it is replaced with its only parent.
514 The effect of this is best shown by way of comparing to
515 '\--full-history' with parent rewriting.  The example turns into:
517 -----------------------------------------------------------------------
518           .-A---M---N---O
519          /     /       /
520         I     B       D
521          \   /       /
522           `---------'
523 -----------------------------------------------------------------------
525 Note the major differences in `N` and `P` over '\--full-history':
528 * `N`'s parent list had `I` removed, because it is an ancestor of the
529   other parent `M`.  Still, `N` remained because it is !TREESAME.
531 * `P`'s parent list similarly had `I` removed.  `P` was then
532   removed completely, because it had one parent and is TREESAME.
535 The '\--simplify-by-decoration' option allows you to view only the
536 big picture of the topology of the history, by omitting commits
537 that are not referenced by tags.  Commits are marked as !TREESAME
538 (in other words, kept after history simplification rules described
539 above) if (1) they are referenced by tags, or (2) they change the
540 contents of the paths given on the command line.  All other
541 commits are marked as TREESAME (subject to be simplified away).
543 ifdef::git-rev-list[]
544 Bisection Helpers
545 ~~~~~~~~~~~~~~~~~
547 --bisect::
549 Limit output to the one commit object which is roughly halfway between
550 included and excluded commits. Note that the bad bisection ref
551 `$GIT_DIR/refs/bisect/bad` is added to the included commits (if it
552 exists) and the good bisection refs `$GIT_DIR/refs/bisect/good-*` are
553 added to the excluded commits (if they exist). Thus, supposing there
554 are no refs in `$GIT_DIR/refs/bisect/`, if
556 -----------------------------------------------------------------------
557         $ git rev-list --bisect foo ^bar ^baz
558 -----------------------------------------------------------------------
560 outputs 'midpoint', the output of the two commands
562 -----------------------------------------------------------------------
563         $ git rev-list foo ^midpoint
564         $ git rev-list midpoint ^bar ^baz
565 -----------------------------------------------------------------------
567 would be of roughly the same length.  Finding the change which
568 introduces a regression is thus reduced to a binary search: repeatedly
569 generate and test new 'midpoint's until the commit chain is of length
570 one.
572 --bisect-vars::
574 This calculates the same as `--bisect`, except that refs in
575 `$GIT_DIR/refs/bisect/` are not used, and except that this outputs
576 text ready to be eval'ed by the shell. These lines will assign the
577 name of the midpoint revision to the variable `bisect_rev`, and the
578 expected number of commits to be tested after `bisect_rev` is tested
579 to `bisect_nr`, the expected number of commits to be tested if
580 `bisect_rev` turns out to be good to `bisect_good`, the expected
581 number of commits to be tested if `bisect_rev` turns out to be bad to
582 `bisect_bad`, and the number of commits we are bisecting right now to
583 `bisect_all`.
585 --bisect-all::
587 This outputs all the commit objects between the included and excluded
588 commits, ordered by their distance to the included and excluded
589 commits. Refs in `$GIT_DIR/refs/bisect/` are not used. The farthest
590 from them is displayed first. (This is the only one displayed by
591 `--bisect`.)
593 This is useful because it makes it easy to choose a good commit to
594 test when you want to avoid to test some of them for some reason (they
595 may not compile for example).
597 This option can be used along with `--bisect-vars`, in this case,
598 after all the sorted commit objects, there will be the same text as if
599 `--bisect-vars` had been used alone.
600 endif::git-rev-list[]
603 Commit Ordering
604 ~~~~~~~~~~~~~~~
606 By default, the commits are shown in reverse chronological order.
608 --topo-order::
610         This option makes them appear in topological order (i.e.
611         descendant commits are shown before their parents).
613 --date-order::
615         This option is similar to '--topo-order' in the sense that no
616         parent comes before all of its children, but otherwise things
617         are still ordered in the commit timestamp order.
619 --reverse::
621         Output the commits in reverse order.
622         Cannot be combined with '\--walk-reflogs'.
624 Object Traversal
625 ~~~~~~~~~~~~~~~~
627 These options are mostly targeted for packing of git repositories.
629 --objects::
631         Print the object IDs of any object referenced by the listed
632         commits.  '--objects foo ^bar' thus means "send me
633         all object IDs which I need to download if I have the commit
634         object 'bar', but not 'foo'".
636 --objects-edge::
638         Similar to '--objects', but also print the IDs of excluded
639         commits prefixed with a "-" character.  This is used by
640         linkgit:git-pack-objects[1] to build "thin" pack, which records
641         objects in deltified form based on objects contained in these
642         excluded commits to reduce network traffic.
644 --unpacked::
646         Only useful with '--objects'; print the object IDs that are not
647         in packs.
649 --no-walk::
651         Only show the given revs, but do not traverse their ancestors.
653 --do-walk::
655         Overrides a previous --no-walk.