rev-list-options.txt 37.6 KB
Newer Older
1 2 3 4 5
Commit Limiting
~~~~~~~~~~~~~~~

Besides specifying a range of commits that should be listed using the
special notations explained in the description, additional commit
6 7 8 9 10 11 12 13 14
limiting may be applied.

Using more options generally further limits the output (e.g.
`--since=<date1>` limits to commits newer than `<date1>`, and using it
with `--grep=<pattern>` further limits to commits whose log message
has a line that matches `<pattern>`), unless otherwise noted.

Note that these are applied before commit
ordering and formatting options, such as `--reverse`.
15

16 17
-<number>::
-n <number>::
18
--max-count=<number>::
19
	Limit the number of commits to output.
20

21
--skip=<number>::
22 23
	Skip 'number' commits before starting to show the commit output.

24 25
--since=<date>::
--after=<date>::
26 27
	Show commits more recent than a specific date.

28 29
--until=<date>::
--before=<date>::
30 31
	Show commits older than a specific date.

32
ifdef::git-rev-list[]
33 34
--max-age=<timestamp>::
--min-age=<timestamp>::
35
	Limit the commits output to specified time range.
36
endif::git-rev-list[]
37

38 39
--author=<pattern>::
--committer=<pattern>::
40
	Limit the commits output to ones with author/committer
41 42 43 44
	header lines that match the specified pattern (regular
	expression).  With more than one `--author=<pattern>`,
	commits whose author matches any of the given patterns are
	chosen (similarly for multiple `--committer=<pattern>`).
45

46 47 48 49
--grep-reflog=<pattern>::
	Limit the commits output to ones with reflog entries that
	match the specified pattern (regular expression). With
	more than one `--grep-reflog`, commits whose reflog message
50 51
	matches any of the given patterns are chosen.  It is an
	error to use this option unless `--walk-reflogs` is in use.
52

53
--grep=<pattern>::
54
	Limit the commits output to ones with log message that
55 56 57 58
	matches the specified pattern (regular expression).  With
	more than one `--grep=<pattern>`, commits whose message
	matches any of the given patterns are chosen (but see
	`--all-match`).
59
ifndef::git-rev-list[]
60
+
61
When `--notes` is in effect, the message from the notes is
62
matched as if it were part of the log message.
63
endif::git-rev-list[]
64

65
--all-match::
66
	Limit the commits output to ones that match all given `--grep`,
67
	instead of ones that match at least one.
68

69 70 71 72
--invert-grep::
	Limit the commits output to ones with log message that do not
	match the pattern specified with `--grep=<pattern>`.

73 74
-i::
--regexp-ignore-case::
75 76
	Match the regular expression limiting patterns without regard to letter
	case.
77

78 79 80 81
--basic-regexp::
	Consider the limiting patterns to be basic regular expressions;
	this is the default.

82 83
-E::
--extended-regexp::
84 85 86
	Consider the limiting patterns to be extended regular expressions
	instead of the default basic regular expressions.

87 88
-F::
--fixed-strings::
89 90 91
	Consider the limiting patterns to be fixed strings (don't interpret
	pattern as a regular expression).

92
-P::
93
--perl-regexp::
94 95 96 97 98 99
	Consider the limiting patterns to be Perl-compatible regular
	expressions.
+
Support for these types of regular expressions is an optional
compile-time dependency. If Git wasn't compiled with support for them
providing this option will cause it to die.
100

101 102 103
--remove-empty::
	Stop when a given path disappears from the tree.

104
--merges::
105
	Print only merge commits. This is exactly the same as `--min-parents=2`.
106

107
--no-merges::
108 109 110 111 112 113 114
	Do not print commits with more than one parent. This is
	exactly the same as `--max-parents=1`.

--min-parents=<number>::
--max-parents=<number>::
--no-min-parents::
--no-max-parents::
115
	Show only commits which have at least (or at most) that many parent
116 117 118 119 120 121 122
	commits. In particular, `--max-parents=1` is the same as `--no-merges`,
	`--min-parents=2` is the same as `--merges`.  `--max-parents=0`
	gives all root commits and `--min-parents=3` all octopus merges.
+
`--no-min-parents` and `--no-max-parents` reset these limits (to no limit)
again.  Equivalent forms are `--min-parents=0` (any commit has 0 or more
parents) and `--max-parents=-1` (negative numbers denote no upper limit).
123 124 125 126 127 128 129 130

--first-parent::
	Follow only the first parent commit upon seeing a merge
	commit.  This option can give a better overview when
	viewing the evolution of a particular topic branch,
	because merges into a topic branch tend to be only about
	adjusting to updated upstream from time to time, and
	this option allows you to ignore the individual commits
131 132
	brought in to your history by such a merge. Cannot be
	combined with --bisect.
133 134 135

--not::
	Reverses the meaning of the '{caret}' prefix (or lack thereof)
136
	for all following revision specifiers, up to the next `--not`.
137 138

--all::
139 140
	Pretend as if all the refs in `refs/`, along with `HEAD`, are
	listed on the command line as '<commit>'.
141

142
--branches[=<pattern>]::
143
	Pretend as if all the refs in `refs/heads` are listed
144
	on the command line as '<commit>'. If '<pattern>' is given, limit
145
	branches to ones matching given shell glob. If pattern lacks '?',
146
	'{asterisk}', or '[', '/{asterisk}' at the end is implied.
147

148
--tags[=<pattern>]::
149
	Pretend as if all the refs in `refs/tags` are listed
150
	on the command line as '<commit>'. If '<pattern>' is given, limit
151 152
	tags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',
	or '[', '/{asterisk}' at the end is implied.
153

154
--remotes[=<pattern>]::
155
	Pretend as if all the refs in `refs/remotes` are listed
156
	on the command line as '<commit>'. If '<pattern>' is given, limit
157
	remote-tracking branches to ones matching given shell glob.
158
	If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied.
159

160 161
--glob=<glob-pattern>::
	Pretend as if all the refs matching shell glob '<glob-pattern>'
Ilari Liusvaara's avatar
Ilari Liusvaara committed
162
	are listed on the command line as '<commit>'. Leading 'refs/',
163 164
	is automatically prepended if missing. If pattern lacks '?', '{asterisk}',
	or '[', '/{asterisk}' at the end is implied.
Ilari Liusvaara's avatar
Ilari Liusvaara committed
165

Johannes Sixt's avatar
Johannes Sixt committed
166 167 168 169 170 171 172
--exclude=<glob-pattern>::

	Do not include refs matching '<glob-pattern>' that the next `--all`,
	`--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
	consider. Repetitions of this option accumulate exclusion patterns
	up to the next `--all`, `--branches`, `--tags`, `--remotes`, or
	`--glob` option (other options or arguments do not clear
Thomas Ackermann's avatar
Thomas Ackermann committed
173
	accumulated patterns).
Johannes Sixt's avatar
Johannes Sixt committed
174 175 176 177 178 179 180
+
The patterns given should not begin with `refs/heads`, `refs/tags`, or
`refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`,
respectively, and they must begin with `refs/` when applied to `--glob`
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
explicitly.

Jeff King's avatar
Jeff King committed
181 182 183 184
--reflog::
	Pretend as if all objects mentioned by reflogs are listed on the
	command line as `<commit>`.

185 186 187 188 189 190 191 192
--alternate-refs::
	Pretend as if all objects mentioned as ref tips of alternate
	repositories were listed on the command line. An alternate
	repository is any repository whose object directory is specified
	in `objects/info/alternates`.  The set of included objects may
	be modified by `core.alternateRefsCommand`, etc. See
	linkgit:git-config[1].

193 194 195 196 197 198 199 200
--single-worktree::
	By default, all working trees will be examined by the
	following options when there are more than one (see
	linkgit:git-worktree[1]): `--all`, `--reflog` and
	`--indexed-objects`.
	This option forces them to examine the current working tree
	only.

Junio C Hamano's avatar
Junio C Hamano committed
201 202 203
--ignore-missing::
	Upon seeing an invalid object name in the input, pretend as if
	the bad input was not given.
Ilari Liusvaara's avatar
Ilari Liusvaara committed
204

205 206
ifndef::git-rev-list[]
--bisect::
207
	Pretend as if the bad bisection ref `refs/bisect/bad`
208
	was listed and as if it was followed by `--not` and the good
209
	bisection refs `refs/bisect/good-*` on the command
210
	line. Cannot be combined with --first-parent.
211 212
endif::git-rev-list[]

213 214
--stdin::
	In addition to the '<commit>' listed on the command
Matthieu Moy's avatar
Matthieu Moy committed
215
	line, read them from the standard input. If a `--` separator is
216 217
	seen, stop reading commits and start reading paths to limit the
	result.
218

219
ifdef::git-rev-list[]
220 221 222 223 224
--quiet::
	Don't print anything to standard output.  This form
	is primarily meant to allow the caller to
	test the exit status to see if a range of objects is fully
	connected (or not).  It is faster than redirecting stdout
225
	to `/dev/null` as the output does not have to be formatted.
226
endif::git-rev-list[]
227

228 229 230 231
--cherry-mark::
	Like `--cherry-pick` (see below) but mark equivalent commits
	with `=` rather than omitting them, and inequivalent ones with `+`.

232 233
--cherry-pick::
	Omit any commit that introduces the same change as
234
	another commit on the ``other side'' when the set of
235 236 237 238
	commits are limited with symmetric difference.
+
For example, if you have two branches, `A` and `B`, a usual way
to list all commits on only one side of them is with
239
`--left-right` (see the example below in the description of
240 241 242
the `--left-right` option). However, it shows the commits that were
cherry-picked from the other branch (for example, ``3rd on b'' may be
cherry-picked from branch A). With this option, such pairs of commits are
243 244
excluded from the output.

245 246
--left-only::
--right-only::
247
	List only commits on the respective side of a symmetric difference,
248 249 250 251 252
	i.e. only those which would be marked `<` resp. `>` by
	`--left-right`.
+
For example, `--cherry-pick --right-only A...B` omits those
commits from `B` which are in `A` or are patch-equivalent to a commit in
253
`A`. In other words, this lists the `+` commits from `git cherry A B`.
254 255 256
More precisely, `--cherry-pick --right-only --no-merges` gives the exact
list.

Michael J Gruber's avatar
Michael J Gruber committed
257 258 259 260 261 262 263
--cherry::
	A synonym for `--right-only --cherry-mark --no-merges`; useful to
	limit the output to the commits on our side and mark those that
	have been applied to the other side of a forked history with
	`git log --cherry upstream...mybranch`, similar to
	`git cherry upstream mybranch`.

264 265
-g::
--walk-reflogs::
266 267 268 269
	Instead of walking the commit ancestry chain, walk
	reflog entries from the most recent one to older ones.
	When this option is used you cannot specify commits to
	exclude (that is, '{caret}commit', 'commit1..commit2',
270
	and 'commit1\...commit2' notations cannot be used).
271
+
272
With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
273
this causes the output to have two extra lines of information
274 275 276 277 278 279 280
taken from the reflog.  The reflog designator in the output may be shown
as `[email protected]{Nth}` (where `Nth` is the reverse-chronological index in the
reflog) or as `[email protected]{timestamp}` (with the timestamp for that entry),
depending on a few rules:
+
--
1. If the starting point is specified as `[email protected]{Nth}`, show the index
Jean-Noël Avila's avatar
Jean-Noël Avila committed
281
   format.
282 283
+
2. If the starting point was specified as `[email protected]{now}`, show the
Jean-Noël Avila's avatar
Jean-Noël Avila committed
284
   timestamp format.
285 286
+
3. If neither was used, but `--date` was given on the command line, show
Jean-Noël Avila's avatar
Jean-Noël Avila committed
287
   the timestamp in the format requested by `--date`.
288 289 290 291 292
+
4. Otherwise, show the index format.
--
+
Under `--pretty=oneline`, the commit message is
293
prefixed with this information on the same line.
294
This option cannot be combined with `--reverse`.
295
See also linkgit:git-reflog[1].
296 297
+
Under `--pretty=reference`, this information will not be shown at all.
298 299 300 301 302 303

--merge::
	After a failed merge, show refs that touch files having a
	conflict and don't exist on all heads to merge.

--boundary::
304 305
	Output excluded boundary commits. Boundary commits are
	prefixed with `-`.
306

307 308 309 310 311 312
ifdef::git-rev-list[]
--use-bitmap-index::

	Try to speed up the traversal using the pack bitmap index (if
	one is available). Note that when traversing with `--objects`,
	trees and blobs will not have their associated path printed.
313 314 315 316

--progress=<header>::
	Show progress reports on stderr as objects are considered. The
	`<header>` text will be printed with each progress update.
317 318
endif::git-rev-list[]

319 320 321
History Simplification
~~~~~~~~~~~~~~~~~~~~~~

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
Sometimes you are only interested in parts of the history, for example the
commits modifying a particular <path>. But there are two parts of
'History Simplification', one part is selecting the commits and the other
is how to do it, as there are various strategies to simplify the history.

The following options select the commits to be shown:

<paths>::
	Commits modifying the given <paths> are selected.

--simplify-by-decoration::
	Commits that are referred by some branch or tag are selected.

Note that extra commits can be shown to give a meaningful history.

The following options affect the way the simplification is performed:

Default mode::
	Simplifies the history to the simplest history explaining the
	final state of the tree. Simplest because it prunes some side
	branches if the end result is the same (i.e. merging branches
	with the same content)

--full-history::
346
	Same as the default mode, but does not prune some history.
347 348 349 350 351 352 353 354 355

--dense::
	Only the selected commits are shown, plus some to have a
	meaningful history.

--sparse::
	All commits in the simplified history are shown.

--simplify-merges::
356
	Additional option to `--full-history` to remove some needless
357 358 359
	merges from the resulting history, as there are no selected
	commits contributing to this merge.

360 361 362 363 364 365 366
--ancestry-path::
	When given a range of commits to display (e.g. 'commit1..commit2'
	or 'commit2 {caret}commit1'), only display commits that exist
	directly on the ancestry chain between the 'commit1' and
	'commit2', i.e. commits that are both descendants of 'commit1',
	and ancestors of 'commit2'.

367
A more detailed explanation follows.
368 369 370 371 372 373 374 375 376

Suppose you specified `foo` as the <paths>.  We shall call commits
that modify `foo` !TREESAME, and the rest TREESAME.  (In a diff
filtered for `foo`, they look different and equal, respectively.)

In the following, we will always refer to the same example history to
illustrate the differences between simplification settings.  We assume
that you are filtering for a file `foo` in this commit graph:
-----------------------------------------------------------------------
377 378 379 380 381
	  .-A---M---N---O---P---Q
	 /     /   /   /   /   /
	I     B   C   D   E   Y
	 \   /   /   /   /   /
	  `-------------'   X
382
-----------------------------------------------------------------------
383
The horizontal line of history A---Q is taken to be the first parent of
384 385 386
each merge.  The commits are:

* `I` is the initial commit, in which `foo` exists with contents
387
  ``asdf'', and a file `quux` exists with contents ``quux''. Initial
388 389
  commits are compared to an empty tree, so `I` is !TREESAME.

390
* In `A`, `foo` contains just ``foo''.
391 392 393 394

* `B` contains the same change as `A`.  Its merge `M` is trivial and
  hence TREESAME to all parents.

395
* `C` does not change `foo`, but its merge `N` changes it to ``foobar'',
396 397
  so it is not TREESAME to any parent.

398 399
* `D` sets `foo` to ``baz''. Its merge `O` combines the strings from
  `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent.
400

401 402
* `E` changes `quux` to ``xyzzy'', and its merge `P` combines the
  strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`.
403

Ondřej Bílka's avatar
Ondřej Bílka committed
404
* `X` is an independent root commit that added a new file `side`, and `Y`
405 406 407
  modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and
  `Q` is TREESAME to `P`, but not to `Y`.

408 409 410
`rev-list` walks backwards through history, including or excluding
commits based on whether `--full-history` and/or parent rewriting
(via `--parents` or `--children`) are used. The following settings
411 412 413 414
are available.

Default mode::
	Commits are included if they are not TREESAME to any parent
415
	(though this can be changed, see `--sparse` below).  If the
416 417 418 419 420 421 422 423 424
	commit was a merge, and it was TREESAME to one parent, follow
	only that parent.  (Even if there are several TREESAME
	parents, follow only one of them.)  Otherwise, follow all
	parents.
+
This results in:
+
-----------------------------------------------------------------------
	  .-A---N---O
425
	 /     /   /
426 427 428 429 430 431 432 433
	I---------D
-----------------------------------------------------------------------
+
Note how the rule to only follow the TREESAME parent, if one is
available, removed `B` from consideration entirely.  `C` was
considered via `N`, but is TREESAME.  Root commits are compared to an
empty tree, so `I` is !TREESAME.
+
434
Parent/child relations are only visible with `--parents`, but that does
435 436 437 438 439 440 441 442 443 444 445
not affect the commits selected in default mode, so we have shown the
parent lines.

--full-history without parent rewriting::
	This mode differs from the default in one point: always follow
	all parents of a merge, even if it is TREESAME to one of them.
	Even if more than one side of the merge has commits that are
	included, this does not imply that the merge itself is!  In
	the example, we get
+
-----------------------------------------------------------------------
446
	I  A  B  N  D  O  P  Q
447 448
-----------------------------------------------------------------------
+
449
`M` was excluded because it is TREESAME to both parents.  `E`,
450 451 452 453 454 455 456 457 458
`C` and `B` were all walked, but only `B` was !TREESAME, so the others
do not appear.
+
Note that without parent rewriting, it is not really possible to talk
about the parent/child relationships between the commits, so we show
them disconnected.

--full-history with parent rewriting::
	Ordinary commits are only included if they are !TREESAME
459
	(though this can be changed, see `--sparse` below).
460 461 462 463 464 465
+
Merges are always included.  However, their parent list is rewritten:
Along each parent, prune away commits that are not included
themselves.  This results in
+
-----------------------------------------------------------------------
466
	  .-A---M---N---O---P---Q
467 468 469 470 471 472
	 /     /   /   /   /
	I     B   /   D   /
	 \   /   /   /   /
	  `-------------'
-----------------------------------------------------------------------
+
473
Compare to `--full-history` without rewriting above.  Note that `E`
474 475
was pruned away because it is TREESAME, but the parent list of P was
rewritten to contain `E`'s parent `I`.  The same happened for `C` and
476
`N`, and `X`, `Y` and `Q`.
477 478 479 480

In addition to the above settings, you can change whether TREESAME
affects inclusion:

481
--dense::
482 483 484
	Commits that are walked are included if they are not TREESAME
	to any parent.

485
--sparse::
486 487
	All commits that are walked are included.
+
488
Note that without `--full-history`, this still simplifies merges: if
489 490
one of the parents is TREESAME, we follow only that one, so the other
sides of the merge are never walked.
491

492 493
--simplify-merges::
	First, build a history graph in the same way that
494
	`--full-history` with parent rewriting does (see above).
495 496 497 498 499 500 501 502
+
Then simplify each commit `C` to its replacement `C'` in the final
history according to the following rules:
+
--
* Set `C'` to `C`.
+
* Replace each parent `P` of `C'` with its simplification `P'`.  In
503 504 505
  the process, drop parents that are ancestors of other parents or that are
  root commits TREESAME to an empty tree, and remove duplicates, but take care
  to never drop all parents that we are TREESAME to.
506 507 508 509 510 511 512
+
* If after this parent rewriting, `C'` is a root or merge commit (has
  zero or >1 parents), a boundary commit, or !TREESAME, it remains.
  Otherwise, it is replaced with its only parent.
--
+
The effect of this is best shown by way of comparing to
513
`--full-history` with parent rewriting.  The example turns into:
514 515 516 517 518 519 520 521 522
+
-----------------------------------------------------------------------
	  .-A---M---N---O
	 /     /       /
	I     B       D
	 \   /       /
	  `---------'
-----------------------------------------------------------------------
+
523
Note the major differences in `N`, `P`, and `Q` over `--full-history`:
524 525 526 527 528 529 530
+
--
* `N`'s parent list had `I` removed, because it is an ancestor of the
  other parent `M`.  Still, `N` remained because it is !TREESAME.
+
* `P`'s parent list similarly had `I` removed.  `P` was then
  removed completely, because it had one parent and is TREESAME.
531 532 533 534
+
* `Q`'s parent list had `Y` simplified to `X`. `X` was then removed, because it
  was a TREESAME root. `Q` was then removed completely, because it had one
  parent and is TREESAME.
535
--
536

537 538 539 540
Finally, there is a fifth simplification mode available:

--ancestry-path::
	Limit the displayed commits to those directly on the ancestry
541 542
	chain between the ``from'' and ``to'' commits in the given commit
	range. I.e. only display commits that are ancestor of the ``to''
543
	commit and descendants of the ``from'' commit.
544 545 546 547 548 549 550 551 552 553 554 555 556 557
+
As an example use case, consider the following commit history:
+
-----------------------------------------------------------------------
	    D---E-------F
	   /     \       \
	  B---C---G---H---I---J
	 /                     \
	A-------K---------------L--M
-----------------------------------------------------------------------
+
A regular 'D..M' computes the set of commits that are ancestors of `M`,
but excludes the ones that are ancestors of `D`. This is useful to see
what happened to the history leading to `M` since `D`, in the sense
558
that ``what does `M` have that did not exist in `D`''. The result in this
559 560 561 562 563 564
example would be all the commits, except `A` and `B` (and `D` itself,
of course).
+
When we want to find out what commits in `M` are contaminated with the
bug introduced by `D` and need fixing, however, we might want to view
only the subset of 'D..M' that are actually descendants of `D`, i.e.
565
excluding `C` and `K`. This is exactly what the `--ancestry-path`
566 567 568 569 570 571 572 573 574 575
option does. Applied to the 'D..M' range, it results in:
+
-----------------------------------------------------------------------
		E-------F
		 \       \
		  G---H---I---J
			       \
				L--M
-----------------------------------------------------------------------

576
The `--simplify-by-decoration` option allows you to view only the
577 578 579 580 581 582 583
big picture of the topology of the history, by omitting commits
that are not referenced by tags.  Commits are marked as !TREESAME
(in other words, kept after history simplification rules described
above) if (1) they are referenced by tags, or (2) they change the
contents of the paths given on the command line.  All other
commits are marked as TREESAME (subject to be simplified away).

584
ifndef::git-shortlog[]
585
ifdef::git-rev-list[]
586 587 588
Bisection Helpers
~~~~~~~~~~~~~~~~~

589
--bisect::
590 591 592 593 594 595 596
	Limit output to the one commit object which is roughly halfway between
	included and excluded commits. Note that the bad bisection ref
	`refs/bisect/bad` is added to the included commits (if it
	exists) and the good bisection refs `refs/bisect/good-*` are
	added to the excluded commits (if they exist). Thus, supposing there
	are no refs in `refs/bisect/`, if
+
597
-----------------------------------------------------------------------
598
	$ git rev-list --bisect foo ^bar ^baz
599
-----------------------------------------------------------------------
600
+
601
outputs 'midpoint', the output of the two commands
602
+
603
-----------------------------------------------------------------------
604 605
	$ git rev-list foo ^midpoint
	$ git rev-list midpoint ^bar ^baz
606
-----------------------------------------------------------------------
607
+
608 609 610
would be of roughly the same length.  Finding the change which
introduces a regression is thus reduced to a binary search: repeatedly
generate and test new 'midpoint's until the commit chain is of length
611
one. Cannot be combined with --first-parent.
612 613

--bisect-vars::
614 615 616 617 618 619 620 621 622 623
	This calculates the same as `--bisect`, except that refs in
	`refs/bisect/` are not used, and except that this outputs
	text ready to be eval'ed by the shell. These lines will assign the
	name of the midpoint revision to the variable `bisect_rev`, and the
	expected number of commits to be tested after `bisect_rev` is tested
	to `bisect_nr`, the expected number of commits to be tested if
	`bisect_rev` turns out to be good to `bisect_good`, the expected
	number of commits to be tested if `bisect_rev` turns out to be bad to
	`bisect_bad`, and the number of commits we are bisecting right now to
	`bisect_all`.
624 625

--bisect-all::
626 627 628 629 630
	This outputs all the commit objects between the included and excluded
	commits, ordered by their distance to the included and excluded
	commits. Refs in `refs/bisect/` are not used. The farthest
	from them is displayed first. (This is the only one displayed by
	`--bisect`.)
631
+
632 633 634
This is useful because it makes it easy to choose a good commit to
test when you want to avoid to test some of them for some reason (they
may not compile for example).
635
+
636 637 638 639
This option can be used along with `--bisect-vars`, in this case,
after all the sorted commit objects, there will be the same text as if
`--bisect-vars` had been used alone.
endif::git-rev-list[]
640
endif::git-shortlog[]
641

642
ifndef::git-shortlog[]
643 644 645 646 647
Commit Ordering
~~~~~~~~~~~~~~~

By default, the commits are shown in reverse chronological order.

648 649 650
--date-order::
	Show no parents before all of its children are shown, but
	otherwise show commits in the commit timestamp order.
651

Junio C Hamano's avatar
Junio C Hamano committed
652 653 654 655
--author-date-order::
	Show no parents before all of its children are shown, but
	otherwise show commits in the author timestamp order.

656 657 658 659 660 661 662 663
--topo-order::
	Show no parents before all of its children are shown, and
	avoid showing commits on multiple lines of history
	intermixed.
+
For example, in a commit history like this:
+
----------------------------------------------------------------
664

665 666 667
    ---1----2----4----7
	\	       \
	 3----5----6----8---
668

669 670 671 672 673 674 675 676 677 678
----------------------------------------------------------------
+
where the numbers denote the order of commit timestamps, `git
rev-list` and friends with `--date-order` show the commits in the
timestamp order: 8 7 6 5 4 3 2 1.
+
With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
3 1); some older commits are shown before newer ones in order to
avoid showing the commits from two parallel development track mixed
together.
679 680

--reverse::
681 682 683
	Output the commits chosen to be shown (see Commit Limiting
	section above) in reverse order. Cannot be combined with
	`--walk-reflogs`.
684
endif::git-shortlog[]
685

686
ifndef::git-shortlog[]
687 688 689
Object Traversal
~~~~~~~~~~~~~~~~

690
These options are mostly targeted for packing of Git repositories.
691

692
ifdef::git-rev-list[]
693 694
--objects::
	Print the object IDs of any object referenced by the listed
695
	commits.  `--objects foo ^bar` thus means ``send me
696
	all object IDs which I need to download if I have the commit
697
	object _bar_ but not _foo_''.
698

699 700 701 702 703
--in-commit-order::
	Print tree and blob ids in order of the commits. The tree
	and blob ids are printed after they are first referenced
	by a commit.

704
--objects-edge::
705 706
	Similar to `--objects`, but also print the IDs of excluded
	commits prefixed with a ``-'' character.  This is used by
707
	linkgit:git-pack-objects[1] to build a ``thin'' pack, which records
708 709 710
	objects in deltified form based on objects contained in these
	excluded commits to reduce network traffic.

711 712
--objects-edge-aggressive::
	Similar to `--objects-edge`, but it tries harder to find excluded
713 714
	commits at the cost of increased time.  This is used instead of
	`--objects-edge` to build ``thin'' packs for shallow repositories.
715

716 717 718 719 720
--indexed-objects::
	Pretend as if all trees and blobs used by the index are listed
	on the command line.  Note that you probably want to use
	`--objects`, too.

721
--unpacked::
722
	Only useful with `--objects`; print the object IDs that are not
723
	in packs.
724

725 726 727 728 729 730 731 732 733 734
--object-names::
	Only useful with `--objects`; print the names of the object IDs
	that are found. This is the default behavior.

--no-object-names::
	Only useful with `--objects`; does not print the names of the object
	IDs that are found. This inverts `--object-names`. This flag allows
	the output to be more easily parsed by commands such as
	linkgit:git-cat-file[1].

735 736 737 738 739 740 741 742
--filter=<filter-spec>::
	Only useful with one of the `--objects*`; omits objects (usually
	blobs) from the list of printed objects.  The '<filter-spec>'
	may be one of the following:
+
The form '--filter=blob:none' omits all blobs.
+
The form '--filter=blob:limit=<n>[kmg]' omits blobs larger than n bytes
743 744 745
or units.  n may be zero.  The suffixes k, m, and g can be used to name
units in KiB, MiB, or GiB.  For example, 'blob:limit=1k' is the same
as 'blob:limit=1024'.
746
+
747 748 749 750
The form '--filter=sparse:oid=<blob-ish>' uses a sparse-checkout
specification contained in the blob (or blob-expression) '<blob-ish>'
to omit blobs that would not be not required for a sparse checkout on
the requested refs.
751
+
752 753
The form '--filter=tree:<depth>' omits all blobs and trees whose depth
from the root tree is >= <depth> (minimum depth if an object is located
754 755 756 757 758 759 760
at multiple depths in the commits traversed). <depth>=0 will not include
any trees or blobs unless included explicitly in the command-line (or
standard input when --stdin is used). <depth>=1 will include only the
tree and blobs which are referenced directly by a commit reachable from
<commit> or an explicitly-given object. <depth>=2 is like <depth>=1
while also including trees and blobs one more level removed from an
explicitly-given commit or tree.
761 762 763 764
+
Note that the form '--filter=sparse:path=<path>' that wants to read
from an arbitrary path on the filesystem has been dropped for security
reasons.
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
+
Multiple '--filter=' flags can be specified to combine filters. Only
objects which are accepted by every filter are included.
+
The form '--filter=combine:<filter1>+<filter2>+...<filterN>' can also be
used to combined several filters, but this is harder than just repeating
the '--filter' flag and is usually not necessary. Filters are joined by
'{plus}' and individual filters are %-encoded (i.e. URL-encoded).
Besides the '{plus}' and '%' characters, the following characters are
reserved and also must be encoded: `[email protected]#$^&*()[]{}\;",<>?`+&#39;&#96;+
as well as all characters with ASCII code &lt;= `0x20`, which includes
space and newline.
+
Other arbitrary characters can also be encoded. For instance,
'combine:tree:3+blob:none' and 'combine:tree%3A3+blob%3Anone' are
equivalent.
781

782 783 784
--no-filter::
	Turn off any previous `--filter=` argument.

785 786
--filter-print-omitted::
	Only useful with `--filter=`; prints a list of the objects omitted
787
	by the filter.  Object IDs are prefixed with a ``~'' character.
788 789 790 791 792 793 794 795 796 797 798 799

--missing=<missing-action>::
	A debug option to help with future "partial clone" development.
	This option specifies how missing objects are handled.
+
The form '--missing=error' requests that rev-list stop with an error if
a missing object is encountered.  This is the default action.
+
The form '--missing=allow-any' will allow object traversal to continue
if a missing object is encountered.  Missing objects will silently be
omitted from the results.
+
800 801 802 803
The form '--missing=allow-promisor' is like 'allow-any', but will only
allow object traversal to continue for EXPECTED promisor missing objects.
Unexpected missing objects will raise an error.
+
804 805
The form '--missing=print' is like 'allow-any', but will also print a
list of the missing objects.  Object IDs are prefixed with a ``?'' character.
806

807 808 809 810 811 812
--exclude-promisor-objects::
	(For internal use only.)  Prefilter object traversal at
	promisor boundary.  This is used with partial clone.  This is
	stronger than `--missing=allow-promisor` because it limits the
	traversal, rather than just silencing errors about missing
	objects.
813
endif::git-rev-list[]
814

815 816 817
--no-walk[=(sorted|unsorted)]::
	Only show the given commits, but do not traverse their ancestors.
	This has no effect if a range is specified. If the argument
818
	`unsorted` is given, the commits are shown in the order they were
819
	given on the command line. Otherwise (if `sorted` or no argument
820
	was given), the commits are shown in reverse chronological order
821
	by commit time.
822
	Cannot be combined with `--graph`.
823 824

--do-walk::
825
	Overrides a previous `--no-walk`.
826
endif::git-shortlog[]
827

828
ifndef::git-shortlog[]
829 830 831 832 833 834 835 836 837 838 839 840 841 842
Commit Formatting
~~~~~~~~~~~~~~~~~

ifdef::git-rev-list[]
Using these options, linkgit:git-rev-list[1] will act similar to the
more specialized family of commit log tools: linkgit:git-log[1],
linkgit:git-show[1], and linkgit:git-whatchanged[1]
endif::git-rev-list[]

include::pretty-options.txt[]

--relative-date::
	Synonym for `--date=relative`.

843
--date=<format>::
844
	Only takes effect for dates shown in human-readable format, such
845
	as when using `--pretty`. `log.date` config variable sets a default
846 847 848 849
	value for the log command's `--date` option. By default, dates
	are shown in the original time zone (either committer's or
	author's). If `-local` is appended to the format (e.g.,
	`iso-local`), the user's local time zone is used instead.
850
+
851
--
852
`--date=relative` shows dates relative to the current time,
853 854
e.g. ``2 hours ago''. The `-local` option has no effect for
`--date=relative`.
855

856
`--date=local` is an alias for `--date=default-local`.
857

858 859 860 861 862 863 864 865 866
`--date=iso` (or `--date=iso8601`) shows timestamps in a ISO 8601-like format.
The differences to the strict ISO 8601 format are:

	- a space instead of the `T` date/time delimiter
	- a space between time and time zone
	- no colon between hours and minutes of the time zone

`--date=iso-strict` (or `--date=iso8601-strict`) shows timestamps in strict
ISO 8601 format.
867

868
`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
869
format, often found in email messages.
870

871
`--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format.
872

873 874 875 876 877
`--date=raw` shows the date as seconds since the epoch (1970-01-01
00:00:00 UTC), followed by a space, and then the timezone as an offset
from UTC (a `+` or `-` with four digits; the first two are hours, and
the second two are minutes). I.e., as if the timestamp were formatted
with `strftime("%s %z")`).
878 879 880
Note that the `-local` option does not affect the seconds-since-epoch
value (which is always measured in UTC), but does switch the accompanying
timezone value.
881

882 883 884 885 886 887
`--date=human` shows the timezone if the timezone does not match the
current time-zone, and doesn't print the whole date if that matches
(ie skip printing year for dates that are "this year", but also skip
the whole date itself if it's in the last few days and we can just say
what weekday it was).  For older dates the hour and minute is also
omitted.
888

Jeff King's avatar
Jeff King committed
889 890 891
`--date=unix` shows the date as a Unix epoch timestamp (seconds since
1970).  As with `--raw`, this is always in UTC and therefore `-local`
has no effect.
892

893 894
`--date=format:...` feeds the format `...` to your system `strftime`,
except for %z and %Z, which are handled internally.
Jeff King's avatar
Jeff King committed
895 896
Use `--date=format:%c` to show the date in your system locale's
preferred format.  See the `strftime` manual for a complete list of
897 898
format placeholders. When using `-local`, the correct syntax is
`--date=format-local:...`.
899

900 901
`--date=default` is the default format, and is similar to
`--date=rfc2822`, with a few exceptions:
902
--
903 904 905
	- there is no comma after the day-of-week

	- the time zone is omitted when the local time zone is used
906 907 908 909 910 911 912 913 914

ifdef::git-rev-list[]
--header::
	Print the contents of the commit in raw-format; each record is
	separated with a NUL character.
endif::git-rev-list[]

--parents::
	Print also the parents of the commit (in the form "commit parent...").
915
	Also enables parent rewriting, see 'History Simplification' above.
916 917 918

--children::
	Print also the children of the commit (in the form "commit child...").
919
	Also enables parent rewriting, see 'History Simplification' above.
920 921 922 923 924 925 926

ifdef::git-rev-list[]
--timestamp::
	Print the raw commit timestamp.
endif::git-rev-list[]

--left-right::
927
	Mark which side of a symmetric difference a commit is reachable from.
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
	Commits from the left side are prefixed with `<` and those from
	the right with `>`.  If combined with `--boundary`, those
	commits are prefixed with `-`.
+
For example, if you have this topology:
+
-----------------------------------------------------------------------
	     y---b---b  branch B
	    / \ /
	   /   .
	  /   / \
	 o---x---a---a  branch A
-----------------------------------------------------------------------
+
you would get an output like this:
+
-----------------------------------------------------------------------
	$ git rev-list --left-right --boundary --pretty=oneline A...B

	>bbbbbbb... 3rd on b
	>bbbbbbb... 2nd on b
	<aaaaaaa... 3rd on a
	<aaaaaaa... 2nd on a
	-yyyyyyy... 1st on b
	-xxxxxxx... 1st on a
-----------------------------------------------------------------------

--graph::
	Draw a text-based graphical representation of the commit history
	on the left hand side of the output.  This may cause extra lines
	to be printed in between commits, in order for the graph history
	to be drawn properly.
960
	Cannot be combined with `--no-walk`.
961
+
962
This enables parent rewriting, see 'History Simplification' above.
963
+
964 965
This implies the `--topo-order` option by default, but the
`--date-order` option may also be specified.
966

967 968 969 970 971 972 973
--show-linear-break[=<barrier>]::
	When --graph is not used, all history branches are flattened
	which can make it hard to see that the two consecutive commits
	do not belong to a linear branch. This option puts a barrier
	in between them in that case. If `<barrier>` is specified, it
	is the string that will be shown instead of the default one.

974 975 976 977
ifdef::git-rev-list[]
--count::
	Print a number stating how many commits would have been
	listed, and suppress all other output.  When used together
978
	with `--left-right`, instead print the counts for left and
979
	right commits, separated by a tab. When used together with
980
	`--cherry-mark`, omit patch equivalent commits from these
981 982
	counts and print the count for equivalent commits separated
	by a tab.
983
endif::git-rev-list[]
984
endif::git-shortlog[]
985

986
ifndef::git-shortlog[]
987 988 989 990
ifndef::git-rev-list[]
Diff Formatting
~~~~~~~~~~~~~~~

991
Listed below are options that control the formatting of diff output.
992 993 994 995 996 997 998 999 1000 1001 1002
Some of them are specific to linkgit:git-rev-list[1], however other diff
options may be given. See linkgit:git-diff-files[1] for more options.

-c::
	With this option, diff output for a merge commit
	shows the differences from each of the parents to the merge result
	simultaneously instead of showing pairwise diff between a parent
	and the result one at a time. Furthermore, it lists only files
	which were modified from all parents.

--cc::
1003
	This flag implies the `-c` option and further compresses the
1004 1005 1006 1007
	patch output by omitting uninteresting hunks whose contents in
	the parents have only two variants and the merge result picks
	one of them without modification.

1008 1009 1010 1011 1012 1013 1014
--combined-all-paths::
	This flag causes combined diffs (used for merge commits) to
	list the name of the file from all parents.  It thus only has
	effect when -c or --cc are specified, and is likely only
	useful if filename changes are detected (i.e. when either
	rename or copy detection have been requested).

1015 1016 1017 1018
-m::
	This flag makes the merge commits show the full diff like
	regular commits; for each merge parent, a separate log entry
	and diff is generated. An exception is that only diff against
1019
	the first parent is shown when `--first-parent` option is given;
1020 1021 1022 1023 1024 1025 1026
	in that case, the output represents the changes the merge
	brought _into_ the then-current branch.

-r::
	Show recursive diffs.

-t::
1027
	Show the tree objects in the diff output. This implies `-r`.
1028
endif::git-rev-list[]
1029
endif::git-shortlog[]