date: document and test "raw-local" mode
[git/debian.git] / Documentation / rev-list-options.txt
blob9215534afa7006273585b19eb68b4b0b698bf88e
1 Commit Limiting
2 ~~~~~~~~~~~~~~~
4 Besides specifying a range of commits that should be listed using the
5 special notations explained in the description, additional commit
6 limiting may be applied.
8 Using more options generally further limits the output (e.g.
9 `--since=<date1>` limits to commits newer than `<date1>`, and using it
10 with `--grep=<pattern>` further limits to commits whose log message
11 has a line that matches `<pattern>`), unless otherwise noted.
13 Note that these are applied before commit
14 ordering and formatting options, such as `--reverse`.
18 -<number>::
19 -n <number>::
20 --max-count=<number>::
21         Limit the number of commits to output.
23 --skip=<number>::
24         Skip 'number' commits before starting to show the commit output.
26 --since=<date>::
27 --after=<date>::
28         Show commits more recent than a specific date.
30 --until=<date>::
31 --before=<date>::
32         Show commits older than a specific date.
34 ifdef::git-rev-list[]
35 --max-age=<timestamp>::
36 --min-age=<timestamp>::
37         Limit the commits output to specified time range.
38 endif::git-rev-list[]
40 --author=<pattern>::
41 --committer=<pattern>::
42         Limit the commits output to ones with author/committer
43         header lines that match the specified pattern (regular
44         expression).  With more than one `--author=<pattern>`,
45         commits whose author matches any of the given patterns are
46         chosen (similarly for multiple `--committer=<pattern>`).
48 --grep-reflog=<pattern>::
49         Limit the commits output to ones with reflog entries that
50         match the specified pattern (regular expression). With
51         more than one `--grep-reflog`, commits whose reflog message
52         matches any of the given patterns are chosen.  It is an
53         error to use this option unless `--walk-reflogs` is in use.
55 --grep=<pattern>::
56         Limit the commits output to ones with log message that
57         matches the specified pattern (regular expression).  With
58         more than one `--grep=<pattern>`, commits whose message
59         matches any of the given patterns are chosen (but see
60         `--all-match`).
61 ifndef::git-rev-list[]
63 When `--show-notes` is in effect, the message from the notes is
64 matched as if it were part of the log message.
65 endif::git-rev-list[]
67 --all-match::
68         Limit the commits output to ones that match all given `--grep`,
69         instead of ones that match at least one.
71 --invert-grep::
72         Limit the commits output to ones with log message that do not
73         match the pattern specified with `--grep=<pattern>`.
75 -i::
76 --regexp-ignore-case::
77         Match the regular expression limiting patterns without regard to letter
78         case.
80 --basic-regexp::
81         Consider the limiting patterns to be basic regular expressions;
82         this is the default.
84 -E::
85 --extended-regexp::
86         Consider the limiting patterns to be extended regular expressions
87         instead of the default basic regular expressions.
89 -F::
90 --fixed-strings::
91         Consider the limiting patterns to be fixed strings (don't interpret
92         pattern as a regular expression).
94 --perl-regexp::
95         Consider the limiting patterns to be Perl-compatible regular expressions.
96         Requires libpcre to be compiled in.
98 --remove-empty::
99         Stop when a given path disappears from the tree.
101 --merges::
102         Print only merge commits. This is exactly the same as `--min-parents=2`.
104 --no-merges::
105         Do not print commits with more than one parent. This is
106         exactly the same as `--max-parents=1`.
108 --min-parents=<number>::
109 --max-parents=<number>::
110 --no-min-parents::
111 --no-max-parents::
112         Show only commits which have at least (or at most) that many parent
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.
117 `--no-min-parents` and `--no-max-parents` reset these limits (to no limit)
118 again.  Equivalent forms are `--min-parents=0` (any commit has 0 or more
119 parents) and `--max-parents=-1` (negative numbers denote no upper limit).
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. Cannot be
129         combined with --bisect.
131 --not::
132         Reverses the meaning of the '{caret}' prefix (or lack thereof)
133         for all following revision specifiers, up to the next `--not`.
135 --all::
136         Pretend as if all the refs in `refs/` are listed on the
137         command line as '<commit>'.
139 --branches[=<pattern>]::
140         Pretend as if all the refs in `refs/heads` are listed
141         on the command line as '<commit>'. If '<pattern>' is given, limit
142         branches to ones matching given shell glob. If pattern lacks '?',
143         '{asterisk}', or '[', '/{asterisk}' at the end is implied.
145 --tags[=<pattern>]::
146         Pretend as if all the refs in `refs/tags` are listed
147         on the command line as '<commit>'. If '<pattern>' is given, limit
148         tags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',
149         or '[', '/{asterisk}' at the end is implied.
151 --remotes[=<pattern>]::
152         Pretend as if all the refs in `refs/remotes` are listed
153         on the command line as '<commit>'. If '<pattern>' is given, limit
154         remote-tracking branches to ones matching given shell glob.
155         If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied.
157 --glob=<glob-pattern>::
158         Pretend as if all the refs matching shell glob '<glob-pattern>'
159         are listed on the command line as '<commit>'. Leading 'refs/',
160         is automatically prepended if missing. If pattern lacks '?', '{asterisk}',
161         or '[', '/{asterisk}' at the end is implied.
163 --exclude=<glob-pattern>::
165         Do not include refs matching '<glob-pattern>' that the next `--all`,
166         `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
167         consider. Repetitions of this option accumulate exclusion patterns
168         up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
169         `--glob` option (other options or arguments do not clear
170         accumulated patterns).
172 The patterns given should not begin with `refs/heads`, `refs/tags`, or
173 `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
174 respectively, and they must begin with `refs/` when applied to `--glob`
175 or `--all`. If a trailing '/{asterisk}' is intended, it must be given
176 explicitly.
178 --reflog::
179         Pretend as if all objects mentioned by reflogs are listed on the
180         command line as `<commit>`.
182 --ignore-missing::
183         Upon seeing an invalid object name in the input, pretend as if
184         the bad input was not given.
186 ifndef::git-rev-list[]
187 --bisect::
188         Pretend as if the bad bisection ref `refs/bisect/bad`
189         was listed and as if it was followed by `--not` and the good
190         bisection refs `refs/bisect/good-*` on the command
191         line. Cannot be combined with --first-parent.
192 endif::git-rev-list[]
194 --stdin::
195         In addition to the '<commit>' listed on the command
196         line, read them from the standard input. If a '--' separator is
197         seen, stop reading commits and start reading paths to limit the
198         result.
200 ifdef::git-rev-list[]
201 --quiet::
202         Don't print anything to standard output.  This form
203         is primarily meant to allow the caller to
204         test the exit status to see if a range of objects is fully
205         connected (or not).  It is faster than redirecting stdout
206         to `/dev/null` as the output does not have to be formatted.
207 endif::git-rev-list[]
209 --cherry-mark::
210         Like `--cherry-pick` (see below) but mark equivalent commits
211         with `=` rather than omitting them, and inequivalent ones with `+`.
213 --cherry-pick::
214         Omit any commit that introduces the same change as
215         another commit on the ``other side'' when the set of
216         commits are limited with symmetric difference.
218 For example, if you have two branches, `A` and `B`, a usual way
219 to list all commits on only one side of them is with
220 `--left-right` (see the example below in the description of
221 the `--left-right` option). However, it shows the commits that were
222 cherry-picked from the other branch (for example, ``3rd on b'' may be
223 cherry-picked from branch A). With this option, such pairs of commits are
224 excluded from the output.
226 --left-only::
227 --right-only::
228         List only commits on the respective side of a symmetric range,
229         i.e. only those which would be marked `<` resp. `>` by
230         `--left-right`.
232 For example, `--cherry-pick --right-only A...B` omits those
233 commits from `B` which are in `A` or are patch-equivalent to a commit in
234 `A`. In other words, this lists the `+` commits from `git cherry A B`.
235 More precisely, `--cherry-pick --right-only --no-merges` gives the exact
236 list.
238 --cherry::
239         A synonym for `--right-only --cherry-mark --no-merges`; useful to
240         limit the output to the commits on our side and mark those that
241         have been applied to the other side of a forked history with
242         `git log --cherry upstream...mybranch`, similar to
243         `git cherry upstream mybranch`.
245 -g::
246 --walk-reflogs::
247         Instead of walking the commit ancestry chain, walk
248         reflog entries from the most recent one to older ones.
249         When this option is used you cannot specify commits to
250         exclude (that is, '{caret}commit', 'commit1..commit2',
251         and 'commit1\...commit2' notations cannot be used).
253 With `--pretty` format other than `oneline` (for obvious reasons),
254 this causes the output to have two extra lines of information
255 taken from the reflog.  The reflog designator in the output may be shown
256 as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the
257 reflog) or as `ref@{timestamp}` (with the timestamp for that entry),
258 depending on a few rules:
261 1. If the starting point is specified as `ref@{Nth}`, show the index
262 format.
264 2. If the starting point was specified as `ref@{now}`, show the
265 timestamp format.
267 3. If neither was used, but `--date` was given on the command line, show
268 the timestamp in the format requested by `--date`.
270 4. Otherwise, show the index format.
273 Under `--pretty=oneline`, the commit message is
274 prefixed with this information on the same line.
275 This option cannot be combined with `--reverse`.
276 See also linkgit:git-reflog[1].
278 --merge::
279         After a failed merge, show refs that touch files having a
280         conflict and don't exist on all heads to merge.
282 --boundary::
283         Output excluded boundary commits. Boundary commits are
284         prefixed with `-`.
286 ifdef::git-rev-list[]
287 --use-bitmap-index::
289         Try to speed up the traversal using the pack bitmap index (if
290         one is available). Note that when traversing with `--objects`,
291         trees and blobs will not have their associated path printed.
292 endif::git-rev-list[]
296 History Simplification
297 ~~~~~~~~~~~~~~~~~~~~~~
299 Sometimes you are only interested in parts of the history, for example the
300 commits modifying a particular <path>. But there are two parts of
301 'History Simplification', one part is selecting the commits and the other
302 is how to do it, as there are various strategies to simplify the history.
304 The following options select the commits to be shown:
306 <paths>::
307         Commits modifying the given <paths> are selected.
309 --simplify-by-decoration::
310         Commits that are referred by some branch or tag are selected.
312 Note that extra commits can be shown to give a meaningful history.
314 The following options affect the way the simplification is performed:
316 Default mode::
317         Simplifies the history to the simplest history explaining the
318         final state of the tree. Simplest because it prunes some side
319         branches if the end result is the same (i.e. merging branches
320         with the same content)
322 --full-history::
323         Same as the default mode, but does not prune some history.
325 --dense::
326         Only the selected commits are shown, plus some to have a
327         meaningful history.
329 --sparse::
330         All commits in the simplified history are shown.
332 --simplify-merges::
333         Additional option to `--full-history` to remove some needless
334         merges from the resulting history, as there are no selected
335         commits contributing to this merge.
337 --ancestry-path::
338         When given a range of commits to display (e.g. 'commit1..commit2'
339         or 'commit2 {caret}commit1'), only display commits that exist
340         directly on the ancestry chain between the 'commit1' and
341         'commit2', i.e. commits that are both descendants of 'commit1',
342         and ancestors of 'commit2'.
344 A more detailed explanation follows.
346 Suppose you specified `foo` as the <paths>.  We shall call commits
347 that modify `foo` !TREESAME, and the rest TREESAME.  (In a diff
348 filtered for `foo`, they look different and equal, respectively.)
350 In the following, we will always refer to the same example history to
351 illustrate the differences between simplification settings.  We assume
352 that you are filtering for a file `foo` in this commit graph:
353 -----------------------------------------------------------------------
354           .-A---M---N---O---P---Q
355          /     /   /   /   /   /
356         I     B   C   D   E   Y
357          \   /   /   /   /   /
358           `-------------'   X
359 -----------------------------------------------------------------------
360 The horizontal line of history A---Q is taken to be the first parent of
361 each merge.  The commits are:
363 * `I` is the initial commit, in which `foo` exists with contents
364   ``asdf'', and a file `quux` exists with contents ``quux''. Initial
365   commits are compared to an empty tree, so `I` is !TREESAME.
367 * In `A`, `foo` contains just ``foo''.
369 * `B` contains the same change as `A`.  Its merge `M` is trivial and
370   hence TREESAME to all parents.
372 * `C` does not change `foo`, but its merge `N` changes it to ``foobar'',
373   so it is not TREESAME to any parent.
375 * `D` sets `foo` to ``baz''. Its merge `O` combines the strings from
376   `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.
378 * `E` changes `quux` to ``xyzzy'', and its merge `P` combines the
379   strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.
381 * `X` is an independent root commit that added a new file `side`, and `Y`
382   modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and
383   `Q` is TREESAME to `P`, but not to `Y`.
385 `rev-list` walks backwards through history, including or excluding
386 commits based on whether `--full-history` and/or parent rewriting
387 (via `--parents` or `--children`) are used. The following settings
388 are available.
390 Default mode::
391         Commits are included if they are not TREESAME to any parent
392         (though this can be changed, see `--sparse` below).  If the
393         commit was a merge, and it was TREESAME to one parent, follow
394         only that parent.  (Even if there are several TREESAME
395         parents, follow only one of them.)  Otherwise, follow all
396         parents.
398 This results in:
400 -----------------------------------------------------------------------
401           .-A---N---O
402          /     /   /
403         I---------D
404 -----------------------------------------------------------------------
406 Note how the rule to only follow the TREESAME parent, if one is
407 available, removed `B` from consideration entirely.  `C` was
408 considered via `N`, but is TREESAME.  Root commits are compared to an
409 empty tree, so `I` is !TREESAME.
411 Parent/child relations are only visible with `--parents`, but that does
412 not affect the commits selected in default mode, so we have shown the
413 parent lines.
415 --full-history without parent rewriting::
416         This mode differs from the default in one point: always follow
417         all parents of a merge, even if it is TREESAME to one of them.
418         Even if more than one side of the merge has commits that are
419         included, this does not imply that the merge itself is!  In
420         the example, we get
422 -----------------------------------------------------------------------
423         I  A  B  N  D  O  P  Q
424 -----------------------------------------------------------------------
426 `M` was excluded because it is TREESAME to both parents.  `E`,
427 `C` and `B` were all walked, but only `B` was !TREESAME, so the others
428 do not appear.
430 Note that without parent rewriting, it is not really possible to talk
431 about the parent/child relationships between the commits, so we show
432 them disconnected.
434 --full-history with parent rewriting::
435         Ordinary commits are only included if they are !TREESAME
436         (though this can be changed, see `--sparse` below).
438 Merges are always included.  However, their parent list is rewritten:
439 Along each parent, prune away commits that are not included
440 themselves.  This results in
442 -----------------------------------------------------------------------
443           .-A---M---N---O---P---Q
444          /     /   /   /   /
445         I     B   /   D   /
446          \   /   /   /   /
447           `-------------'
448 -----------------------------------------------------------------------
450 Compare to `--full-history` without rewriting above.  Note that `E`
451 was pruned away because it is TREESAME, but the parent list of P was
452 rewritten to contain `E`'s parent `I`.  The same happened for `C` and
453 `N`, and `X`, `Y` and `Q`.
455 In addition to the above settings, you can change whether TREESAME
456 affects inclusion:
458 --dense::
459         Commits that are walked are included if they are not TREESAME
460         to any parent.
462 --sparse::
463         All commits that are walked are included.
465 Note that without `--full-history`, this still simplifies merges: if
466 one of the parents is TREESAME, we follow only that one, so the other
467 sides of the merge are never walked.
469 --simplify-merges::
470         First, build a history graph in the same way that
471         `--full-history` with parent rewriting does (see above).
473 Then simplify each commit `C` to its replacement `C'` in the final
474 history according to the following rules:
477 * Set `C'` to `C`.
479 * Replace each parent `P` of `C'` with its simplification `P'`.  In
480   the process, drop parents that are ancestors of other parents or that are
481   root commits TREESAME to an empty tree, and remove duplicates, but take care
482   to never drop all parents that we are TREESAME to.
484 * If after this parent rewriting, `C'` is a root or merge commit (has
485   zero or >1 parents), a boundary commit, or !TREESAME, it remains.
486   Otherwise, it is replaced with its only parent.
489 The effect of this is best shown by way of comparing to
490 `--full-history` with parent rewriting.  The example turns into:
492 -----------------------------------------------------------------------
493           .-A---M---N---O
494          /     /       /
495         I     B       D
496          \   /       /
497           `---------'
498 -----------------------------------------------------------------------
500 Note the major differences in `N`, `P`, and `Q` over `--full-history`:
503 * `N`'s parent list had `I` removed, because it is an ancestor of the
504   other parent `M`.  Still, `N` remained because it is !TREESAME.
506 * `P`'s parent list similarly had `I` removed.  `P` was then
507   removed completely, because it had one parent and is TREESAME.
509 * `Q`'s parent list had `Y` simplified to `X`. `X` was then removed, because it
510   was a TREESAME root. `Q` was then removed completely, because it had one
511   parent and is TREESAME.
514 Finally, there is a fifth simplification mode available:
516 --ancestry-path::
517         Limit the displayed commits to those directly on the ancestry
518         chain between the ``from'' and ``to'' commits in the given commit
519         range. I.e. only display commits that are ancestor of the ``to''
520         commit and descendants of the ``from'' commit.
522 As an example use case, consider the following commit history:
524 -----------------------------------------------------------------------
525             D---E-------F
526            /     \       \
527           B---C---G---H---I---J
528          /                     \
529         A-------K---------------L--M
530 -----------------------------------------------------------------------
532 A regular 'D..M' computes the set of commits that are ancestors of `M`,
533 but excludes the ones that are ancestors of `D`. This is useful to see
534 what happened to the history leading to `M` since `D`, in the sense
535 that ``what does `M` have that did not exist in `D`''. The result in this
536 example would be all the commits, except `A` and `B` (and `D` itself,
537 of course).
539 When we want to find out what commits in `M` are contaminated with the
540 bug introduced by `D` and need fixing, however, we might want to view
541 only the subset of 'D..M' that are actually descendants of `D`, i.e.
542 excluding `C` and `K`. This is exactly what the `--ancestry-path`
543 option does. Applied to the 'D..M' range, it results in:
545 -----------------------------------------------------------------------
546                 E-------F
547                  \       \
548                   G---H---I---J
549                                \
550                                 L--M
551 -----------------------------------------------------------------------
553 The `--simplify-by-decoration` option allows you to view only the
554 big picture of the topology of the history, by omitting commits
555 that are not referenced by tags.  Commits are marked as !TREESAME
556 (in other words, kept after history simplification rules described
557 above) if (1) they are referenced by tags, or (2) they change the
558 contents of the paths given on the command line.  All other
559 commits are marked as TREESAME (subject to be simplified away).
561 ifdef::git-rev-list[]
562 Bisection Helpers
563 ~~~~~~~~~~~~~~~~~
565 --bisect::
566         Limit output to the one commit object which is roughly halfway between
567         included and excluded commits. Note that the bad bisection ref
568         `refs/bisect/bad` is added to the included commits (if it
569         exists) and the good bisection refs `refs/bisect/good-*` are
570         added to the excluded commits (if they exist). Thus, supposing there
571         are no refs in `refs/bisect/`, if
573 -----------------------------------------------------------------------
574         $ git rev-list --bisect foo ^bar ^baz
575 -----------------------------------------------------------------------
577 outputs 'midpoint', the output of the two commands
579 -----------------------------------------------------------------------
580         $ git rev-list foo ^midpoint
581         $ git rev-list midpoint ^bar ^baz
582 -----------------------------------------------------------------------
584 would be of roughly the same length.  Finding the change which
585 introduces a regression is thus reduced to a binary search: repeatedly
586 generate and test new 'midpoint's until the commit chain is of length
587 one. Cannot be combined with --first-parent.
589 --bisect-vars::
590         This calculates the same as `--bisect`, except that refs in
591         `refs/bisect/` are not used, and except that this outputs
592         text ready to be eval'ed by the shell. These lines will assign the
593         name of the midpoint revision to the variable `bisect_rev`, and the
594         expected number of commits to be tested after `bisect_rev` is tested
595         to `bisect_nr`, the expected number of commits to be tested if
596         `bisect_rev` turns out to be good to `bisect_good`, the expected
597         number of commits to be tested if `bisect_rev` turns out to be bad to
598         `bisect_bad`, and the number of commits we are bisecting right now to
599         `bisect_all`.
601 --bisect-all::
602         This outputs all the commit objects between the included and excluded
603         commits, ordered by their distance to the included and excluded
604         commits. Refs in `refs/bisect/` are not used. The farthest
605         from them is displayed first. (This is the only one displayed by
606         `--bisect`.)
608 This is useful because it makes it easy to choose a good commit to
609 test when you want to avoid to test some of them for some reason (they
610 may not compile for example).
612 This option can be used along with `--bisect-vars`, in this case,
613 after all the sorted commit objects, there will be the same text as if
614 `--bisect-vars` had been used alone.
615 endif::git-rev-list[]
618 Commit Ordering
619 ~~~~~~~~~~~~~~~
621 By default, the commits are shown in reverse chronological order.
623 --date-order::
624         Show no parents before all of its children are shown, but
625         otherwise show commits in the commit timestamp order.
627 --author-date-order::
628         Show no parents before all of its children are shown, but
629         otherwise show commits in the author timestamp order.
631 --topo-order::
632         Show no parents before all of its children are shown, and
633         avoid showing commits on multiple lines of history
634         intermixed.
636 For example, in a commit history like this:
638 ----------------------------------------------------------------
640     ---1----2----4----7
641         \              \
642          3----5----6----8---
644 ----------------------------------------------------------------
646 where the numbers denote the order of commit timestamps, `git
647 rev-list` and friends with `--date-order` show the commits in the
648 timestamp order: 8 7 6 5 4 3 2 1.
650 With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
651 3 1); some older commits are shown before newer ones in order to
652 avoid showing the commits from two parallel development track mixed
653 together.
655 --reverse::
656         Output the commits in reverse order.
657         Cannot be combined with `--walk-reflogs`.
659 Object Traversal
660 ~~~~~~~~~~~~~~~~
662 These options are mostly targeted for packing of Git repositories.
664 ifdef::git-rev-list[]
665 --objects::
666         Print the object IDs of any object referenced by the listed
667         commits.  `--objects foo ^bar` thus means ``send me
668         all object IDs which I need to download if I have the commit
669         object _bar_ but not _foo_''.
671 --objects-edge::
672         Similar to `--objects`, but also print the IDs of excluded
673         commits prefixed with a ``-'' character.  This is used by
674         linkgit:git-pack-objects[1] to build a ``thin'' pack, which records
675         objects in deltified form based on objects contained in these
676         excluded commits to reduce network traffic.
678 --objects-edge-aggressive::
679         Similar to `--objects-edge`, but it tries harder to find excluded
680         commits at the cost of increased time.  This is used instead of
681         `--objects-edge` to build ``thin'' packs for shallow repositories.
683 --indexed-objects::
684         Pretend as if all trees and blobs used by the index are listed
685         on the command line.  Note that you probably want to use
686         `--objects`, too.
688 --unpacked::
689         Only useful with `--objects`; print the object IDs that are not
690         in packs.
691 endif::git-rev-list[]
693 --no-walk[=(sorted|unsorted)]::
694         Only show the given commits, but do not traverse their ancestors.
695         This has no effect if a range is specified. If the argument
696         `unsorted` is given, the commits are shown in the order they were
697         given on the command line. Otherwise (if `sorted` or no argument
698         was given), the commits are shown in reverse chronological order
699         by commit time.
700         Cannot be combined with `--graph`.
702 --do-walk::
703         Overrides a previous `--no-walk`.
705 Commit Formatting
706 ~~~~~~~~~~~~~~~~~
708 ifdef::git-rev-list[]
709 Using these options, linkgit:git-rev-list[1] will act similar to the
710 more specialized family of commit log tools: linkgit:git-log[1],
711 linkgit:git-show[1], and linkgit:git-whatchanged[1]
712 endif::git-rev-list[]
714 include::pretty-options.txt[]
716 --relative-date::
717         Synonym for `--date=relative`.
719 --date=<format>::
720         Only takes effect for dates shown in human-readable format, such
721         as when using `--pretty`. `log.date` config variable sets a default
722         value for the log command's `--date` option. By default, dates
723         are shown in the original time zone (either committer's or
724         author's). If `-local` is appended to the format (e.g.,
725         `iso-local`), the user's local time zone is used instead.
727 `--date=relative` shows dates relative to the current time,
728 e.g. ``2 hours ago''. The `-local` option has no effect for
729 `--date=relative`.
731 `--date=local` is an alias for `--date=default-local`.
733 `--date=iso` (or `--date=iso8601`) shows timestamps in a ISO 8601-like format.
734 The differences to the strict ISO 8601 format are:
736         - a space instead of the `T` date/time delimiter
737         - a space between time and time zone
738         - no colon between hours and minutes of the time zone
741 `--date=iso-strict` (or `--date=iso8601-strict`) shows timestamps in strict
742 ISO 8601 format.
744 `--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
745 format, often found in email messages.
747 `--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format.
749 `--date=raw` shows the date in the internal raw Git format `%s %z` format.
750 Note that the `-local` option does not affect the seconds-since-epoch
751 value (which is always measured in UTC), but does switch the accompanying
752 timezone value.
754 `--date=format:...` feeds the format `...` to your system `strftime`.
755 Use `--date=format:%c` to show the date in your system locale's
756 preferred format.  See the `strftime` manual for a complete list of
757 format placeholders. When using `-local`, the correct syntax is
758 `--date=format-local:...`.
760 `--date=default` is the default format, and is similar to
761 `--date=rfc2822`, with a few exceptions:
763         - there is no comma after the day-of-week
765         - the time zone is omitted when the local time zone is used
767 ifdef::git-rev-list[]
768 --header::
769         Print the contents of the commit in raw-format; each record is
770         separated with a NUL character.
771 endif::git-rev-list[]
773 --parents::
774         Print also the parents of the commit (in the form "commit parent...").
775         Also enables parent rewriting, see 'History Simplification' below.
777 --children::
778         Print also the children of the commit (in the form "commit child...").
779         Also enables parent rewriting, see 'History Simplification' below.
781 ifdef::git-rev-list[]
782 --timestamp::
783         Print the raw commit timestamp.
784 endif::git-rev-list[]
786 --left-right::
787         Mark which side of a symmetric diff a commit is reachable from.
788         Commits from the left side are prefixed with `<` and those from
789         the right with `>`.  If combined with `--boundary`, those
790         commits are prefixed with `-`.
792 For example, if you have this topology:
794 -----------------------------------------------------------------------
795              y---b---b  branch B
796             / \ /
797            /   .
798           /   / \
799          o---x---a---a  branch A
800 -----------------------------------------------------------------------
802 you would get an output like this:
804 -----------------------------------------------------------------------
805         $ git rev-list --left-right --boundary --pretty=oneline A...B
807         >bbbbbbb... 3rd on b
808         >bbbbbbb... 2nd on b
809         <aaaaaaa... 3rd on a
810         <aaaaaaa... 2nd on a
811         -yyyyyyy... 1st on b
812         -xxxxxxx... 1st on a
813 -----------------------------------------------------------------------
815 --graph::
816         Draw a text-based graphical representation of the commit history
817         on the left hand side of the output.  This may cause extra lines
818         to be printed in between commits, in order for the graph history
819         to be drawn properly.
820         Cannot be combined with `--no-walk`.
822 This enables parent rewriting, see 'History Simplification' below.
824 This implies the `--topo-order` option by default, but the
825 `--date-order` option may also be specified.
827 --show-linear-break[=<barrier>]::
828         When --graph is not used, all history branches are flattened
829         which can make it hard to see that the two consecutive commits
830         do not belong to a linear branch. This option puts a barrier
831         in between them in that case. If `<barrier>` is specified, it
832         is the string that will be shown instead of the default one.
834 ifdef::git-rev-list[]
835 --count::
836         Print a number stating how many commits would have been
837         listed, and suppress all other output.  When used together
838         with `--left-right`, instead print the counts for left and
839         right commits, separated by a tab. When used together with
840         `--cherry-mark`, omit patch equivalent commits from these
841         counts and print the count for equivalent commits separated
842         by a tab.
843 endif::git-rev-list[]
845 ifndef::git-rev-list[]
846 Diff Formatting
847 ~~~~~~~~~~~~~~~
849 Listed below are options that control the formatting of diff output.
850 Some of them are specific to linkgit:git-rev-list[1], however other diff
851 options may be given. See linkgit:git-diff-files[1] for more options.
853 -c::
854         With this option, diff output for a merge commit
855         shows the differences from each of the parents to the merge result
856         simultaneously instead of showing pairwise diff between a parent
857         and the result one at a time. Furthermore, it lists only files
858         which were modified from all parents.
860 --cc::
861         This flag implies the `-c` option and further compresses the
862         patch output by omitting uninteresting hunks whose contents in
863         the parents have only two variants and the merge result picks
864         one of them without modification.
866 -m::
867         This flag makes the merge commits show the full diff like
868         regular commits; for each merge parent, a separate log entry
869         and diff is generated. An exception is that only diff against
870         the first parent is shown when `--first-parent` option is given;
871         in that case, the output represents the changes the merge
872         brought _into_ the then-current branch.
874 -r::
875         Show recursive diffs.
877 -t::
878         Show the tree objects in the diff output. This implies `-r`.
879 endif::git-rev-list[]