Documentation / rev-list-options.txton commit rev-list: add optional progress reporting (434ea3c)
   1Commit Limiting
   2~~~~~~~~~~~~~~~
   3
   4Besides specifying a range of commits that should be listed using the
   5special notations explained in the description, additional commit
   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`.
  15
  16--
  17
  18-<number>::
  19-n <number>::
  20--max-count=<number>::
  21        Limit the number of commits to output.
  22
  23--skip=<number>::
  24        Skip 'number' commits before starting to show the commit output.
  25
  26--since=<date>::
  27--after=<date>::
  28        Show commits more recent than a specific date.
  29
  30--until=<date>::
  31--before=<date>::
  32        Show commits older than a specific date.
  33
  34ifdef::git-rev-list[]
  35--max-age=<timestamp>::
  36--min-age=<timestamp>::
  37        Limit the commits output to specified time range.
  38endif::git-rev-list[]
  39
  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>`).
  47
  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.
  54
  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`).
  61ifndef::git-rev-list[]
  62+
  63When `--show-notes` is in effect, the message from the notes is
  64matched as if it were part of the log message.
  65endif::git-rev-list[]
  66
  67--all-match::
  68        Limit the commits output to ones that match all given `--grep`,
  69        instead of ones that match at least one.
  70
  71--invert-grep::
  72        Limit the commits output to ones with log message that do not
  73        match the pattern specified with `--grep=<pattern>`.
  74
  75-i::
  76--regexp-ignore-case::
  77        Match the regular expression limiting patterns without regard to letter
  78        case.
  79
  80--basic-regexp::
  81        Consider the limiting patterns to be basic regular expressions;
  82        this is the default.
  83
  84-E::
  85--extended-regexp::
  86        Consider the limiting patterns to be extended regular expressions
  87        instead of the default basic regular expressions.
  88
  89-F::
  90--fixed-strings::
  91        Consider the limiting patterns to be fixed strings (don't interpret
  92        pattern as a regular expression).
  93
  94--perl-regexp::
  95        Consider the limiting patterns to be Perl-compatible regular expressions.
  96        Requires libpcre to be compiled in.
  97
  98--remove-empty::
  99        Stop when a given path disappears from the tree.
 100
 101--merges::
 102        Print only merge commits. This is exactly the same as `--min-parents=2`.
 103
 104--no-merges::
 105        Do not print commits with more than one parent. This is
 106        exactly the same as `--max-parents=1`.
 107
 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.
 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).
 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. Cannot be
 129        combined with --bisect.
 130
 131--not::
 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        Pretend as if all the refs in `refs/` are listed on the
 137        command line as '<commit>'.
 138
 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.
 144
 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.
 150
 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.
 156
 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.
 162
 163--exclude=<glob-pattern>::
 164
 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).
 171+
 172The patterns given should not begin with `refs/heads`, `refs/tags`, or
 173`refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
 174respectively, and they must begin with `refs/` when applied to `--glob`
 175or `--all`. If a trailing '/{asterisk}' is intended, it must be given
 176explicitly.
 177
 178--reflog::
 179        Pretend as if all objects mentioned by reflogs are listed on the
 180        command line as `<commit>`.
 181
 182--ignore-missing::
 183        Upon seeing an invalid object name in the input, pretend as if
 184        the bad input was not given.
 185
 186ifndef::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.
 192endif::git-rev-list[]
 193
 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.
 199
 200ifdef::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.
 207endif::git-rev-list[]
 208
 209--cherry-mark::
 210        Like `--cherry-pick` (see below) but mark equivalent commits
 211        with `=` rather than omitting them, and inequivalent ones with `+`.
 212
 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.
 217+
 218For example, if you have two branches, `A` and `B`, a usual way
 219to list all commits on only one side of them is with
 220`--left-right` (see the example below in the description of
 221the `--left-right` option). However, it shows the commits that were
 222cherry-picked from the other branch (for example, ``3rd on b'' may be
 223cherry-picked from branch A). With this option, such pairs of commits are
 224excluded from the output.
 225
 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`.
 231+
 232For example, `--cherry-pick --right-only A...B` omits those
 233commits 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`.
 235More precisely, `--cherry-pick --right-only --no-merges` gives the exact
 236list.
 237
 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`.
 244
 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).
 252+
 253With `--pretty` format other than `oneline` (for obvious reasons),
 254this causes the output to have two extra lines of information
 255taken from the reflog.  By default, 'commit@\{Nth}' notation is
 256used in the output.  When the starting commit is specified as
 257'commit@\{now}', output also uses 'commit@\{timestamp}' notation
 258instead.  Under `--pretty=oneline`, the commit message is
 259prefixed with this information on the same line.
 260This option cannot be combined with `--reverse`.
 261See also linkgit:git-reflog[1].
 262
 263--merge::
 264        After a failed merge, show refs that touch files having a
 265        conflict and don't exist on all heads to merge.
 266
 267--boundary::
 268        Output excluded boundary commits. Boundary commits are
 269        prefixed with `-`.
 270
 271ifdef::git-rev-list[]
 272--use-bitmap-index::
 273
 274        Try to speed up the traversal using the pack bitmap index (if
 275        one is available). Note that when traversing with `--objects`,
 276        trees and blobs will not have their associated path printed.
 277
 278--progress=<header>::
 279        Show progress reports on stderr as objects are considered. The
 280        `<header>` text will be printed with each progress update.
 281endif::git-rev-list[]
 282
 283--
 284
 285History Simplification
 286~~~~~~~~~~~~~~~~~~~~~~
 287
 288Sometimes you are only interested in parts of the history, for example the
 289commits modifying a particular <path>. But there are two parts of
 290'History Simplification', one part is selecting the commits and the other
 291is how to do it, as there are various strategies to simplify the history.
 292
 293The following options select the commits to be shown:
 294
 295<paths>::
 296        Commits modifying the given <paths> are selected.
 297
 298--simplify-by-decoration::
 299        Commits that are referred by some branch or tag are selected.
 300
 301Note that extra commits can be shown to give a meaningful history.
 302
 303The following options affect the way the simplification is performed:
 304
 305Default mode::
 306        Simplifies the history to the simplest history explaining the
 307        final state of the tree. Simplest because it prunes some side
 308        branches if the end result is the same (i.e. merging branches
 309        with the same content)
 310
 311--full-history::
 312        Same as the default mode, but does not prune some history.
 313
 314--dense::
 315        Only the selected commits are shown, plus some to have a
 316        meaningful history.
 317
 318--sparse::
 319        All commits in the simplified history are shown.
 320
 321--simplify-merges::
 322        Additional option to `--full-history` to remove some needless
 323        merges from the resulting history, as there are no selected
 324        commits contributing to this merge.
 325
 326--ancestry-path::
 327        When given a range of commits to display (e.g. 'commit1..commit2'
 328        or 'commit2 {caret}commit1'), only display commits that exist
 329        directly on the ancestry chain between the 'commit1' and
 330        'commit2', i.e. commits that are both descendants of 'commit1',
 331        and ancestors of 'commit2'.
 332
 333A more detailed explanation follows.
 334
 335Suppose you specified `foo` as the <paths>.  We shall call commits
 336that modify `foo` !TREESAME, and the rest TREESAME.  (In a diff
 337filtered for `foo`, they look different and equal, respectively.)
 338
 339In the following, we will always refer to the same example history to
 340illustrate the differences between simplification settings.  We assume
 341that you are filtering for a file `foo` in this commit graph:
 342-----------------------------------------------------------------------
 343          .-A---M---N---O---P---Q
 344         /     /   /   /   /   /
 345        I     B   C   D   E   Y
 346         \   /   /   /   /   /
 347          `-------------'   X
 348-----------------------------------------------------------------------
 349The horizontal line of history A---Q is taken to be the first parent of
 350each merge.  The commits are:
 351
 352* `I` is the initial commit, in which `foo` exists with contents
 353  ``asdf'', and a file `quux` exists with contents ``quux''. Initial
 354  commits are compared to an empty tree, so `I` is !TREESAME.
 355
 356* In `A`, `foo` contains just ``foo''.
 357
 358* `B` contains the same change as `A`.  Its merge `M` is trivial and
 359  hence TREESAME to all parents.
 360
 361* `C` does not change `foo`, but its merge `N` changes it to ``foobar'',
 362  so it is not TREESAME to any parent.
 363
 364* `D` sets `foo` to ``baz''. Its merge `O` combines the strings from
 365  `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.
 366
 367* `E` changes `quux` to ``xyzzy'', and its merge `P` combines the
 368  strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.
 369
 370* `X` is an independent root commit that added a new file `side`, and `Y`
 371  modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and
 372  `Q` is TREESAME to `P`, but not to `Y`.
 373
 374`rev-list` walks backwards through history, including or excluding
 375commits based on whether `--full-history` and/or parent rewriting
 376(via `--parents` or `--children`) are used. The following settings
 377are available.
 378
 379Default mode::
 380        Commits are included if they are not TREESAME to any parent
 381        (though this can be changed, see `--sparse` below).  If the
 382        commit was a merge, and it was TREESAME to one parent, follow
 383        only that parent.  (Even if there are several TREESAME
 384        parents, follow only one of them.)  Otherwise, follow all
 385        parents.
 386+
 387This results in:
 388+
 389-----------------------------------------------------------------------
 390          .-A---N---O
 391         /     /   /
 392        I---------D
 393-----------------------------------------------------------------------
 394+
 395Note how the rule to only follow the TREESAME parent, if one is
 396available, removed `B` from consideration entirely.  `C` was
 397considered via `N`, but is TREESAME.  Root commits are compared to an
 398empty tree, so `I` is !TREESAME.
 399+
 400Parent/child relations are only visible with `--parents`, but that does
 401not affect the commits selected in default mode, so we have shown the
 402parent lines.
 403
 404--full-history without parent rewriting::
 405        This mode differs from the default in one point: always follow
 406        all parents of a merge, even if it is TREESAME to one of them.
 407        Even if more than one side of the merge has commits that are
 408        included, this does not imply that the merge itself is!  In
 409        the example, we get
 410+
 411-----------------------------------------------------------------------
 412        I  A  B  N  D  O  P  Q
 413-----------------------------------------------------------------------
 414+
 415`M` was excluded because it is TREESAME to both parents.  `E`,
 416`C` and `B` were all walked, but only `B` was !TREESAME, so the others
 417do not appear.
 418+
 419Note that without parent rewriting, it is not really possible to talk
 420about the parent/child relationships between the commits, so we show
 421them disconnected.
 422
 423--full-history with parent rewriting::
 424        Ordinary commits are only included if they are !TREESAME
 425        (though this can be changed, see `--sparse` below).
 426+
 427Merges are always included.  However, their parent list is rewritten:
 428Along each parent, prune away commits that are not included
 429themselves.  This results in
 430+
 431-----------------------------------------------------------------------
 432          .-A---M---N---O---P---Q
 433         /     /   /   /   /
 434        I     B   /   D   /
 435         \   /   /   /   /
 436          `-------------'
 437-----------------------------------------------------------------------
 438+
 439Compare to `--full-history` without rewriting above.  Note that `E`
 440was pruned away because it is TREESAME, but the parent list of P was
 441rewritten to contain `E`'s parent `I`.  The same happened for `C` and
 442`N`, and `X`, `Y` and `Q`.
 443
 444In addition to the above settings, you can change whether TREESAME
 445affects inclusion:
 446
 447--dense::
 448        Commits that are walked are included if they are not TREESAME
 449        to any parent.
 450
 451--sparse::
 452        All commits that are walked are included.
 453+
 454Note that without `--full-history`, this still simplifies merges: if
 455one of the parents is TREESAME, we follow only that one, so the other
 456sides of the merge are never walked.
 457
 458--simplify-merges::
 459        First, build a history graph in the same way that
 460        `--full-history` with parent rewriting does (see above).
 461+
 462Then simplify each commit `C` to its replacement `C'` in the final
 463history according to the following rules:
 464+
 465--
 466* Set `C'` to `C`.
 467+
 468* Replace each parent `P` of `C'` with its simplification `P'`.  In
 469  the process, drop parents that are ancestors of other parents or that are
 470  root commits TREESAME to an empty tree, and remove duplicates, but take care
 471  to never drop all parents that we are TREESAME to.
 472+
 473* If after this parent rewriting, `C'` is a root or merge commit (has
 474  zero or >1 parents), a boundary commit, or !TREESAME, it remains.
 475  Otherwise, it is replaced with its only parent.
 476--
 477+
 478The effect of this is best shown by way of comparing to
 479`--full-history` with parent rewriting.  The example turns into:
 480+
 481-----------------------------------------------------------------------
 482          .-A---M---N---O
 483         /     /       /
 484        I     B       D
 485         \   /       /
 486          `---------'
 487-----------------------------------------------------------------------
 488+
 489Note the major differences in `N`, `P`, and `Q` over `--full-history`:
 490+
 491--
 492* `N`'s parent list had `I` removed, because it is an ancestor of the
 493  other parent `M`.  Still, `N` remained because it is !TREESAME.
 494+
 495* `P`'s parent list similarly had `I` removed.  `P` was then
 496  removed completely, because it had one parent and is TREESAME.
 497+
 498* `Q`'s parent list had `Y` simplified to `X`. `X` was then removed, because it
 499  was a TREESAME root. `Q` was then removed completely, because it had one
 500  parent and is TREESAME.
 501--
 502
 503Finally, there is a fifth simplification mode available:
 504
 505--ancestry-path::
 506        Limit the displayed commits to those directly on the ancestry
 507        chain between the ``from'' and ``to'' commits in the given commit
 508        range. I.e. only display commits that are ancestor of the ``to''
 509        commit and descendants of the ``from'' commit.
 510+
 511As an example use case, consider the following commit history:
 512+
 513-----------------------------------------------------------------------
 514            D---E-------F
 515           /     \       \
 516          B---C---G---H---I---J
 517         /                     \
 518        A-------K---------------L--M
 519-----------------------------------------------------------------------
 520+
 521A regular 'D..M' computes the set of commits that are ancestors of `M`,
 522but excludes the ones that are ancestors of `D`. This is useful to see
 523what happened to the history leading to `M` since `D`, in the sense
 524that ``what does `M` have that did not exist in `D`''. The result in this
 525example would be all the commits, except `A` and `B` (and `D` itself,
 526of course).
 527+
 528When we want to find out what commits in `M` are contaminated with the
 529bug introduced by `D` and need fixing, however, we might want to view
 530only the subset of 'D..M' that are actually descendants of `D`, i.e.
 531excluding `C` and `K`. This is exactly what the `--ancestry-path`
 532option does. Applied to the 'D..M' range, it results in:
 533+
 534-----------------------------------------------------------------------
 535                E-------F
 536                 \       \
 537                  G---H---I---J
 538                               \
 539                                L--M
 540-----------------------------------------------------------------------
 541
 542The `--simplify-by-decoration` option allows you to view only the
 543big picture of the topology of the history, by omitting commits
 544that are not referenced by tags.  Commits are marked as !TREESAME
 545(in other words, kept after history simplification rules described
 546above) if (1) they are referenced by tags, or (2) they change the
 547contents of the paths given on the command line.  All other
 548commits are marked as TREESAME (subject to be simplified away).
 549
 550ifdef::git-rev-list[]
 551Bisection Helpers
 552~~~~~~~~~~~~~~~~~
 553
 554--bisect::
 555        Limit output to the one commit object which is roughly halfway between
 556        included and excluded commits. Note that the bad bisection ref
 557        `refs/bisect/bad` is added to the included commits (if it
 558        exists) and the good bisection refs `refs/bisect/good-*` are
 559        added to the excluded commits (if they exist). Thus, supposing there
 560        are no refs in `refs/bisect/`, if
 561+
 562-----------------------------------------------------------------------
 563        $ git rev-list --bisect foo ^bar ^baz
 564-----------------------------------------------------------------------
 565+
 566outputs 'midpoint', the output of the two commands
 567+
 568-----------------------------------------------------------------------
 569        $ git rev-list foo ^midpoint
 570        $ git rev-list midpoint ^bar ^baz
 571-----------------------------------------------------------------------
 572+
 573would be of roughly the same length.  Finding the change which
 574introduces a regression is thus reduced to a binary search: repeatedly
 575generate and test new 'midpoint's until the commit chain is of length
 576one. Cannot be combined with --first-parent.
 577
 578--bisect-vars::
 579        This calculates the same as `--bisect`, except that refs in
 580        `refs/bisect/` are not used, and except that this outputs
 581        text ready to be eval'ed by the shell. These lines will assign the
 582        name of the midpoint revision to the variable `bisect_rev`, and the
 583        expected number of commits to be tested after `bisect_rev` is tested
 584        to `bisect_nr`, the expected number of commits to be tested if
 585        `bisect_rev` turns out to be good to `bisect_good`, the expected
 586        number of commits to be tested if `bisect_rev` turns out to be bad to
 587        `bisect_bad`, and the number of commits we are bisecting right now to
 588        `bisect_all`.
 589
 590--bisect-all::
 591        This outputs all the commit objects between the included and excluded
 592        commits, ordered by their distance to the included and excluded
 593        commits. Refs in `refs/bisect/` are not used. The farthest
 594        from them is displayed first. (This is the only one displayed by
 595        `--bisect`.)
 596+
 597This is useful because it makes it easy to choose a good commit to
 598test when you want to avoid to test some of them for some reason (they
 599may not compile for example).
 600+
 601This option can be used along with `--bisect-vars`, in this case,
 602after all the sorted commit objects, there will be the same text as if
 603`--bisect-vars` had been used alone.
 604endif::git-rev-list[]
 605
 606
 607Commit Ordering
 608~~~~~~~~~~~~~~~
 609
 610By default, the commits are shown in reverse chronological order.
 611
 612--date-order::
 613        Show no parents before all of its children are shown, but
 614        otherwise show commits in the commit timestamp order.
 615
 616--author-date-order::
 617        Show no parents before all of its children are shown, but
 618        otherwise show commits in the author timestamp order.
 619
 620--topo-order::
 621        Show no parents before all of its children are shown, and
 622        avoid showing commits on multiple lines of history
 623        intermixed.
 624+
 625For example, in a commit history like this:
 626+
 627----------------------------------------------------------------
 628
 629    ---1----2----4----7
 630        \              \
 631         3----5----6----8---
 632
 633----------------------------------------------------------------
 634+
 635where the numbers denote the order of commit timestamps, `git
 636rev-list` and friends with `--date-order` show the commits in the
 637timestamp order: 8 7 6 5 4 3 2 1.
 638+
 639With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
 6403 1); some older commits are shown before newer ones in order to
 641avoid showing the commits from two parallel development track mixed
 642together.
 643
 644--reverse::
 645        Output the commits in reverse order.
 646        Cannot be combined with `--walk-reflogs`.
 647
 648Object Traversal
 649~~~~~~~~~~~~~~~~
 650
 651These options are mostly targeted for packing of Git repositories.
 652
 653ifdef::git-rev-list[]
 654--objects::
 655        Print the object IDs of any object referenced by the listed
 656        commits.  `--objects foo ^bar` thus means ``send me
 657        all object IDs which I need to download if I have the commit
 658        object _bar_ but not _foo_''.
 659
 660--objects-edge::
 661        Similar to `--objects`, but also print the IDs of excluded
 662        commits prefixed with a ``-'' character.  This is used by
 663        linkgit:git-pack-objects[1] to build a ``thin'' pack, which records
 664        objects in deltified form based on objects contained in these
 665        excluded commits to reduce network traffic.
 666
 667--objects-edge-aggressive::
 668        Similar to `--objects-edge`, but it tries harder to find excluded
 669        commits at the cost of increased time.  This is used instead of
 670        `--objects-edge` to build ``thin'' packs for shallow repositories.
 671
 672--indexed-objects::
 673        Pretend as if all trees and blobs used by the index are listed
 674        on the command line.  Note that you probably want to use
 675        `--objects`, too.
 676
 677--unpacked::
 678        Only useful with `--objects`; print the object IDs that are not
 679        in packs.
 680endif::git-rev-list[]
 681
 682--no-walk[=(sorted|unsorted)]::
 683        Only show the given commits, but do not traverse their ancestors.
 684        This has no effect if a range is specified. If the argument
 685        `unsorted` is given, the commits are shown in the order they were
 686        given on the command line. Otherwise (if `sorted` or no argument
 687        was given), the commits are shown in reverse chronological order
 688        by commit time.
 689        Cannot be combined with `--graph`.
 690
 691--do-walk::
 692        Overrides a previous `--no-walk`.
 693
 694Commit Formatting
 695~~~~~~~~~~~~~~~~~
 696
 697ifdef::git-rev-list[]
 698Using these options, linkgit:git-rev-list[1] will act similar to the
 699more specialized family of commit log tools: linkgit:git-log[1],
 700linkgit:git-show[1], and linkgit:git-whatchanged[1]
 701endif::git-rev-list[]
 702
 703include::pretty-options.txt[]
 704
 705--relative-date::
 706        Synonym for `--date=relative`.
 707
 708--date=<format>::
 709        Only takes effect for dates shown in human-readable format, such
 710        as when using `--pretty`. `log.date` config variable sets a default
 711        value for the log command's `--date` option. By default, dates
 712        are shown in the original time zone (either committer's or
 713        author's). If `-local` is appended to the format (e.g.,
 714        `iso-local`), the user's local time zone is used instead.
 715+
 716`--date=relative` shows dates relative to the current time,
 717e.g. ``2 hours ago''. The `-local` option cannot be used with
 718`--raw` or `--relative`.
 719+
 720`--date=local` is an alias for `--date=default-local`.
 721+
 722`--date=iso` (or `--date=iso8601`) shows timestamps in a ISO 8601-like format.
 723The differences to the strict ISO 8601 format are:
 724
 725        - a space instead of the `T` date/time delimiter
 726        - a space between time and time zone
 727        - no colon between hours and minutes of the time zone
 728
 729+
 730`--date=iso-strict` (or `--date=iso8601-strict`) shows timestamps in strict
 731ISO 8601 format.
 732+
 733`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
 734format, often found in email messages.
 735+
 736`--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format.
 737+
 738`--date=raw` shows the date in the internal raw Git format `%s %z` format.
 739+
 740`--date=format:...` feeds the format `...` to your system `strftime`.
 741Use `--date=format:%c` to show the date in your system locale's
 742preferred format.  See the `strftime` manual for a complete list of
 743format placeholders. When using `-local`, the correct syntax is
 744`--date=format-local:...`.
 745+
 746`--date=default` is the default format, and is similar to
 747`--date=rfc2822`, with a few exceptions:
 748
 749        - there is no comma after the day-of-week
 750
 751        - the time zone is omitted when the local time zone is used
 752
 753ifdef::git-rev-list[]
 754--header::
 755        Print the contents of the commit in raw-format; each record is
 756        separated with a NUL character.
 757endif::git-rev-list[]
 758
 759--parents::
 760        Print also the parents of the commit (in the form "commit parent...").
 761        Also enables parent rewriting, see 'History Simplification' below.
 762
 763--children::
 764        Print also the children of the commit (in the form "commit child...").
 765        Also enables parent rewriting, see 'History Simplification' below.
 766
 767ifdef::git-rev-list[]
 768--timestamp::
 769        Print the raw commit timestamp.
 770endif::git-rev-list[]
 771
 772--left-right::
 773        Mark which side of a symmetric diff a commit is reachable from.
 774        Commits from the left side are prefixed with `<` and those from
 775        the right with `>`.  If combined with `--boundary`, those
 776        commits are prefixed with `-`.
 777+
 778For example, if you have this topology:
 779+
 780-----------------------------------------------------------------------
 781             y---b---b  branch B
 782            / \ /
 783           /   .
 784          /   / \
 785         o---x---a---a  branch A
 786-----------------------------------------------------------------------
 787+
 788you would get an output like this:
 789+
 790-----------------------------------------------------------------------
 791        $ git rev-list --left-right --boundary --pretty=oneline A...B
 792
 793        >bbbbbbb... 3rd on b
 794        >bbbbbbb... 2nd on b
 795        <aaaaaaa... 3rd on a
 796        <aaaaaaa... 2nd on a
 797        -yyyyyyy... 1st on b
 798        -xxxxxxx... 1st on a
 799-----------------------------------------------------------------------
 800
 801--graph::
 802        Draw a text-based graphical representation of the commit history
 803        on the left hand side of the output.  This may cause extra lines
 804        to be printed in between commits, in order for the graph history
 805        to be drawn properly.
 806        Cannot be combined with `--no-walk`.
 807+
 808This enables parent rewriting, see 'History Simplification' below.
 809+
 810This implies the `--topo-order` option by default, but the
 811`--date-order` option may also be specified.
 812
 813--show-linear-break[=<barrier>]::
 814        When --graph is not used, all history branches are flattened
 815        which can make it hard to see that the two consecutive commits
 816        do not belong to a linear branch. This option puts a barrier
 817        in between them in that case. If `<barrier>` is specified, it
 818        is the string that will be shown instead of the default one.
 819
 820ifdef::git-rev-list[]
 821--count::
 822        Print a number stating how many commits would have been
 823        listed, and suppress all other output.  When used together
 824        with `--left-right`, instead print the counts for left and
 825        right commits, separated by a tab. When used together with
 826        `--cherry-mark`, omit patch equivalent commits from these
 827        counts and print the count for equivalent commits separated
 828        by a tab.
 829endif::git-rev-list[]
 830
 831ifndef::git-rev-list[]
 832Diff Formatting
 833~~~~~~~~~~~~~~~
 834
 835Listed below are options that control the formatting of diff output.
 836Some of them are specific to linkgit:git-rev-list[1], however other diff
 837options may be given. See linkgit:git-diff-files[1] for more options.
 838
 839-c::
 840        With this option, diff output for a merge commit
 841        shows the differences from each of the parents to the merge result
 842        simultaneously instead of showing pairwise diff between a parent
 843        and the result one at a time. Furthermore, it lists only files
 844        which were modified from all parents.
 845
 846--cc::
 847        This flag implies the `-c` option and further compresses the
 848        patch output by omitting uninteresting hunks whose contents in
 849        the parents have only two variants and the merge result picks
 850        one of them without modification.
 851
 852-m::
 853        This flag makes the merge commits show the full diff like
 854        regular commits; for each merge parent, a separate log entry
 855        and diff is generated. An exception is that only diff against
 856        the first parent is shown when `--first-parent` option is given;
 857        in that case, the output represents the changes the merge
 858        brought _into_ the then-current branch.
 859
 860-r::
 861        Show recursive diffs.
 862
 863-t::
 864        Show the tree objects in the diff output. This implies `-r`.
 865endif::git-rev-list[]