| blob | 4c4319a6cdb9b52c848a29e917d2e79b382458c5 |
1 '\" t
2 .\" Title: git-replay
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-10
6 .\" Manual: Git Manual
7 .\" Source: Git 2.46.0.551.gc5ee8f2d1c
8 .\" Language: English
9 .\"
10 .TH "GIT\-REPLAY" "1" "2024-09-10" "Git 2\&.46\&.0\&.551\&.gc5ee8f" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-replay \- EXPERIMENTAL: Replay commits on a new base, works with bare repos too
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 (EXPERIMENTAL!) \fIgit replay\fR ([\-\-contained] \-\-onto <newbase> | \-\-advance <branch>) <revision\-range>\&...\:
36 .fi
37 .SH "DESCRIPTION"
38 .sp
39 Takes ranges of commits and replays them onto a new location\&. Leaves the working tree and the index untouched, and updates no references\&. The output of this command is meant to be used as input to \fBgit update\-ref \-\-stdin\fR, which would update the relevant branches (see the OUTPUT section below)\&.
40 .sp
41 THIS COMMAND IS EXPERIMENTAL\&. THE BEHAVIOR MAY CHANGE\&.
42 .SH "OPTIONS"
43 .PP
44 \-\-onto <newbase>
45 .RS 4
46 Starting point at which to create the new commits\&. May be any valid commit, and not just an existing branch name\&.
47 .sp
48 When
49 \fB\-\-onto\fR
50 is specified, the update\-ref command(s) in the output will update the branch(es) in the revision range to point at the new commits, similar to the way how
51 \fBgit rebase \-\-update\-refs\fR
52 updates multiple branches in the affected range\&.
53 .RE
54 .PP
55 \-\-advance <branch>
56 .RS 4
57 Starting point at which to create the new commits; must be a branch name\&.
58 .sp
59 When
60 \fB\-\-advance\fR
61 is specified, the update\-ref command(s) in the output will update the branch passed as an argument to
62 \fB\-\-advance\fR
63 to point at the new commits (in other words, this mimics a cherry\-pick operation)\&.
64 .RE
65 .PP
66 <revision\-range>
67 .RS 4
68 Range of commits to replay\&. More than one <revision\-range> can be passed, but in
69 \fB\-\-advance <branch>\fR
70 mode, they should have a single tip, so that it\(cqs clear where <branch> should point to\&. See "Specifying Ranges" in
71 \fBgit-rev-parse\fR(1)
72 and the "Commit Limiting" options below\&.
73 .RE
74 .SS "Commit Limiting"
75 .sp
76 Besides specifying a range of commits that should be listed using the special notations explained in the description, additional commit limiting may be applied\&.
77 .sp
78 Using more options generally further limits the output (e\&.g\&. \fB\-\-since=<date1>\fR limits to commits newer than \fB<date1>\fR, and using it with \fB\-\-grep=<pattern>\fR further limits to commits whose log message has a line that matches \fB<pattern>\fR), unless otherwise noted\&.
79 .sp
80 Note that these are applied before commit ordering and formatting options, such as \fB\-\-reverse\fR\&.
81 .PP
82 \-<number>, \-n <number>, \-\-max\-count=<number>
83 .RS 4
84 Limit the number of commits to output\&.
85 .RE
86 .PP
87 \-\-skip=<number>
88 .RS 4
89 Skip
90 \fInumber\fR
91 commits before starting to show the commit output\&.
92 .RE
93 .PP
94 \-\-since=<date>, \-\-after=<date>
95 .RS 4
96 Show commits more recent than a specific date\&.
97 .RE
98 .PP
99 \-\-since\-as\-filter=<date>
100 .RS 4
101 Show all commits more recent than a specific date\&. This visits all commits in the range, rather than stopping at the first commit which is older than a specific date\&.
102 .RE
103 .PP
104 \-\-until=<date>, \-\-before=<date>
105 .RS 4
106 Show commits older than a specific date\&.
107 .RE
108 .PP
109 \-\-author=<pattern>, \-\-committer=<pattern>
110 .RS 4
111 Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression)\&. With more than one
112 \fB\-\-author=<pattern>\fR, commits whose author matches any of the given patterns are chosen (similarly for multiple
113 \fB\-\-committer=<pattern>\fR)\&.
114 .RE
115 .PP
116 \-\-grep\-reflog=<pattern>
117 .RS 4
118 Limit the commits output to ones with reflog entries that match the specified pattern (regular expression)\&. With more than one
119 \fB\-\-grep\-reflog\fR, commits whose reflog message matches any of the given patterns are chosen\&. It is an error to use this option unless
120 \fB\-\-walk\-reflogs\fR
121 is in use\&.
122 .RE
123 .PP
124 \-\-grep=<pattern>
125 .RS 4
126 Limit the commits output to ones with a log message that matches the specified pattern (regular expression)\&. With more than one
127 \fB\-\-grep=<pattern>\fR, commits whose message matches any of the given patterns are chosen (but see
128 \fB\-\-all\-match\fR)\&.
129 .sp
130 When
131 \fB\-\-notes\fR
132 is in effect, the message from the notes is matched as if it were part of the log message\&.
133 .RE
134 .PP
135 \-\-all\-match
136 .RS 4
137 Limit the commits output to ones that match all given
138 \fB\-\-grep\fR, instead of ones that match at least one\&.
139 .RE
140 .PP
141 \-\-invert\-grep
142 .RS 4
143 Limit the commits output to ones with a log message that do not match the pattern specified with
144 \fB\-\-grep=<pattern>\fR\&.
145 .RE
146 .PP
147 \-i, \-\-regexp\-ignore\-case
148 .RS 4
149 Match the regular expression limiting patterns without regard to letter case\&.
150 .RE
151 .PP
152 \-\-basic\-regexp
153 .RS 4
154 Consider the limiting patterns to be basic regular expressions; this is the default\&.
155 .RE
156 .PP
157 \-E, \-\-extended\-regexp
158 .RS 4
159 Consider the limiting patterns to be extended regular expressions instead of the default basic regular expressions\&.
160 .RE
161 .PP
162 \-F, \-\-fixed\-strings
163 .RS 4
164 Consider the limiting patterns to be fixed strings (don\(cqt interpret pattern as a regular expression)\&.
165 .RE
166 .PP
167 \-P, \-\-perl\-regexp
168 .RS 4
169 Consider the limiting patterns to be Perl\-compatible regular expressions\&.
170 .sp
171 Support for these types of regular expressions is an optional compile\-time dependency\&. If Git wasn\(cqt compiled with support for them providing this option will cause it to die\&.
172 .RE
173 .PP
174 \-\-remove\-empty
175 .RS 4
176 Stop when a given path disappears from the tree\&.
177 .RE
178 .PP
179 \-\-merges
180 .RS 4
181 Print only merge commits\&. This is exactly the same as
182 \fB\-\-min\-parents=2\fR\&.
183 .RE
184 .PP
185 \-\-no\-merges
186 .RS 4
187 Do not print commits with more than one parent\&. This is exactly the same as
188 \fB\-\-max\-parents=1\fR\&.
189 .RE
190 .PP
191 \-\-min\-parents=<number>, \-\-max\-parents=<number>, \-\-no\-min\-parents, \-\-no\-max\-parents
192 .RS 4
193 Show only commits which have at least (or at most) that many parent commits\&. In particular,
194 \fB\-\-max\-parents=1\fR
195 is the same as
196 \fB\-\-no\-merges\fR,
197 \fB\-\-min\-parents=2\fR
198 is the same as
199 \fB\-\-merges\fR\&.
200 \fB\-\-max\-parents=0\fR
201 gives all root commits and
202 \fB\-\-min\-parents=3\fR
203 all octopus merges\&.
204 .sp
205 \fB\-\-no\-min\-parents\fR
206 and
207 \fB\-\-no\-max\-parents\fR
208 reset these limits (to no limit) again\&. Equivalent forms are
209 \fB\-\-min\-parents=0\fR
210 (any commit has 0 or more parents) and
211 \fB\-\-max\-parents=\-1\fR
212 (negative numbers denote no upper limit)\&.
213 .RE
214 .PP
215 \-\-first\-parent
216 .RS 4
217 When finding commits to include, 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 brought in to your history by such a merge\&.
218 .RE
219 .PP
220 \-\-exclude\-first\-parent\-only
221 .RS 4
222 When finding commits to exclude (with a
223 \fI^\fR), follow only the first parent commit upon seeing a merge commit\&. This can be used to find the set of changes in a topic branch from the point where it diverged from the remote branch, given that arbitrary merges can be valid topic branch changes\&.
224 .RE
225 .PP
226 \-\-not
227 .RS 4
228 Reverses the meaning of the
229 \fI^\fR
230 prefix (or lack thereof) for all following revision specifiers, up to the next
231 \fB\-\-not\fR\&. When used on the command line before \-\-stdin, the revisions passed through stdin will not be affected by it\&. Conversely, when passed via standard input, the revisions passed on the command line will not be affected by it\&.
232 .RE
233 .PP
234 \-\-all
235 .RS 4
236 Pretend as if all the refs in
237 \fBrefs/\fR, along with
238 \fBHEAD\fR, are listed on the command line as
239 \fI<commit>\fR\&.
240 .RE
241 .PP
242 \-\-branches[=<pattern>]
243 .RS 4
244 Pretend as if all the refs in
245 \fBrefs/heads\fR
246 are listed on the command line as
247 \fI<commit>\fR\&. If
248 \fI<pattern>\fR
249 is given, limit branches to ones matching given shell glob\&. If pattern lacks
250 \fI?\fR,
251 \fI*\fR, or
252 \fI[\fR,
253 \fI/*\fR
254 at the end is implied\&.
255 .RE
256 .PP
257 \-\-tags[=<pattern>]
258 .RS 4
259 Pretend as if all the refs in
260 \fBrefs/tags\fR
261 are listed on the command line as
262 \fI<commit>\fR\&. If
263 \fI<pattern>\fR
264 is given, limit tags to ones matching given shell glob\&. If pattern lacks
265 \fI?\fR,
266 \fI*\fR, or
267 \fI[\fR,
268 \fI/*\fR
269 at the end is implied\&.
270 .RE
271 .PP
272 \-\-remotes[=<pattern>]
273 .RS 4
274 Pretend as if all the refs in
275 \fBrefs/remotes\fR
276 are listed on the command line as
277 \fI<commit>\fR\&. If
278 \fI<pattern>\fR
279 is given, limit remote\-tracking branches to ones matching given shell glob\&. If pattern lacks
280 \fI?\fR,
281 \fI*\fR, or
282 \fI[\fR,
283 \fI/*\fR
284 at the end is implied\&.
285 .RE
286 .PP
287 \-\-glob=<glob\-pattern>
288 .RS 4
289 Pretend as if all the refs matching shell glob
290 \fI<glob\-pattern>\fR
291 are listed on the command line as
292 \fI<commit>\fR\&. Leading
293 \fIrefs/\fR, is automatically prepended if missing\&. If pattern lacks
294 \fI?\fR,
295 \fI*\fR, or
296 \fI[\fR,
297 \fI/*\fR
298 at the end is implied\&.
299 .RE
300 .PP
301 \-\-exclude=<glob\-pattern>
302 .RS 4
303 Do not include refs matching
304 \fI<glob\-pattern>\fR
305 that the next
306 \fB\-\-all\fR,
307 \fB\-\-branches\fR,
308 \fB\-\-tags\fR,
309 \fB\-\-remotes\fR, or
310 \fB\-\-glob\fR
311 would otherwise consider\&. Repetitions of this option accumulate exclusion patterns up to the next
312 \fB\-\-all\fR,
313 \fB\-\-branches\fR,
314 \fB\-\-tags\fR,
315 \fB\-\-remotes\fR, or
316 \fB\-\-glob\fR
317 option (other options or arguments do not clear accumulated patterns)\&.
318 .sp
319 The patterns given should not begin with
320 \fBrefs/heads\fR,
321 \fBrefs/tags\fR, or
322 \fBrefs/remotes\fR
323 when applied to
324 \fB\-\-branches\fR,
325 \fB\-\-tags\fR, or
326 \fB\-\-remotes\fR, respectively, and they must begin with
327 \fBrefs/\fR
328 when applied to
329 \fB\-\-glob\fR
330 or
331 \fB\-\-all\fR\&. If a trailing
332 \fI/*\fR
333 is intended, it must be given explicitly\&.
334 .RE
335 .PP
336 \-\-exclude\-hidden=[fetch|receive|uploadpack]
337 .RS 4
338 Do not include refs that would be hidden by
339 \fBgit\-fetch\fR,
340 \fBgit\-receive\-pack\fR
341 or
342 \fBgit\-upload\-pack\fR
343 by consulting the appropriate
344 \fBfetch\&.hideRefs\fR,
345 \fBreceive\&.hideRefs\fR
346 or
347 \fBuploadpack\&.hideRefs\fR
348 configuration along with
349 \fBtransfer\&.hideRefs\fR
350 (see
351 \fBgit-config\fR(1))\&. This option affects the next pseudo\-ref option
352 \fB\-\-all\fR
353 or
354 \fB\-\-glob\fR
355 and is cleared after processing them\&.
356 .RE
357 .PP
358 \-\-reflog
359 .RS 4
360 Pretend as if all objects mentioned by reflogs are listed on the command line as
361 \fB<commit>\fR\&.
362 .RE
363 .PP
364 \-\-alternate\-refs
365 .RS 4
366 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
367 \fBobjects/info/alternates\fR\&. The set of included objects may be modified by
368 \fBcore\&.alternateRefsCommand\fR, etc\&. See
369 \fBgit-config\fR(1)\&.
370 .RE
371 .PP
372 \-\-single\-worktree
373 .RS 4
374 By default, all working trees will be examined by the following options when there are more than one (see
375 \fBgit-worktree\fR(1)):
376 \fB\-\-all\fR,
377 \fB\-\-reflog\fR
378 and
379 \fB\-\-indexed\-objects\fR\&. This option forces them to examine the current working tree only\&.
380 .RE
381 .PP
382 \-\-ignore\-missing
383 .RS 4
384 Upon seeing an invalid object name in the input, pretend as if the bad input was not given\&.
385 .RE
386 .PP
387 \-\-bisect
388 .RS 4
389 Pretend as if the bad bisection ref
390 \fBrefs/bisect/bad\fR
391 was listed and as if it was followed by
392 \fB\-\-not\fR
393 and the good bisection refs
394 \fBrefs/bisect/good\-*\fR
395 on the command line\&.
396 .RE
397 .PP
398 \-\-stdin
399 .RS 4
400 In addition to getting arguments from the command line, read them from standard input as well\&. This accepts commits and pseudo\-options like
401 \fB\-\-all\fR
402 and
403 \fB\-\-glob=\fR\&. When a
404 \fB\-\-\fR
405 separator is seen, the following input is treated as paths and used to limit the result\&. Flags like
406 \fB\-\-not\fR
407 which are read via standard input are only respected for arguments passed in the same way and will not influence any subsequent command line arguments\&.
408 .RE
409 .PP
410 \-\-cherry\-mark
411 .RS 4
412 Like
413 \fB\-\-cherry\-pick\fR
414 (see below) but mark equivalent commits with
415 \fB=\fR
416 rather than omitting them, and inequivalent ones with
417 \fB+\fR\&.
418 .RE
419 .PP
420 \-\-cherry\-pick
421 .RS 4
422 Omit any commit that introduces the same change as another commit on the
423 \(lqother side\(rq
424 when the set of commits are limited with symmetric difference\&.
425 .sp
426 For example, if you have two branches,
427 \fBA\fR
428 and
429 \fBB\fR, a usual way to list all commits on only one side of them is with
430 \fB\-\-left\-right\fR
431 (see the example below in the description of the
432 \fB\-\-left\-right\fR
433 option)\&. However, it shows the commits that were cherry\-picked from the other branch (for example,
434 \(lq3rd on b\(rq
435 may be cherry\-picked from branch A)\&. With this option, such pairs of commits are excluded from the output\&.
436 .RE
437 .PP
438 \-\-left\-only, \-\-right\-only
439 .RS 4
440 List only commits on the respective side of a symmetric difference, i\&.e\&. only those which would be marked
441 \fB<\fR
442 resp\&.
443 \fB>\fR
444 by
445 \fB\-\-left\-right\fR\&.
446 .sp
447 For example,
448 \fB\-\-cherry\-pick \-\-right\-only A\&.\&.\&.B\fR
449 omits those commits from
450 \fBB\fR
451 which are in
452 \fBA\fR
453 or are patch\-equivalent to a commit in
454 \fBA\fR\&. In other words, this lists the
455 \fB+\fR
456 commits from
457 \fBgit cherry A B\fR\&. More precisely,
458 \fB\-\-cherry\-pick \-\-right\-only \-\-no\-merges\fR
459 gives the exact list\&.
460 .RE
461 .PP
462 \-\-cherry
463 .RS 4
464 A synonym for
465 \fB\-\-right\-only \-\-cherry\-mark \-\-no\-merges\fR; 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
466 \fBgit log \-\-cherry upstream\&.\&.\&.mybranch\fR, similar to
467 \fBgit cherry upstream mybranch\fR\&.
468 .RE
469 .PP
470 \-g, \-\-walk\-reflogs
471 .RS 4
472 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,
473 \fI^commit\fR,
474 \fIcommit1\&.\&.commit2\fR, and
475 \fIcommit1\&.\&.\&.commit2\fR
476 notations cannot be used)\&.
477 .sp
478 With
479 \fB\-\-pretty\fR
480 format other than
481 \fBoneline\fR
482 and
483 \fBreference\fR
484 (for obvious reasons), this causes the output to have two extra lines of information taken from the reflog\&. The reflog designator in the output may be shown as
485 \fBref@{<Nth>}\fR
486 (where
487 \fI<Nth>\fR
488 is the reverse\-chronological index in the reflog) or as
489 \fBref@{<timestamp>}\fR
490 (with the
491 \fI<timestamp>\fR
492 for that entry), depending on a few rules:
493 .sp
494 .RS 4
495 .ie n \{\
496 \h'-04' 1.\h'+01'\c
497 .\}
498 .el \{\
499 .sp -1
500 .IP " 1." 4.2
501 .\}
502 If the starting point is specified as
503 \fBref@{<Nth>}\fR, show the index format\&.
504 .RE
505 .sp
506 .RS 4
507 .ie n \{\
508 \h'-04' 2.\h'+01'\c
509 .\}
510 .el \{\
511 .sp -1
512 .IP " 2." 4.2
513 .\}
514 If the starting point was specified as
515 \fBref@{now}\fR, show the timestamp format\&.
516 .RE
517 .sp
518 .RS 4
519 .ie n \{\
520 \h'-04' 3.\h'+01'\c
521 .\}
522 .el \{\
523 .sp -1
524 .IP " 3." 4.2
525 .\}
526 If neither was used, but
527 \fB\-\-date\fR
528 was given on the command line, show the timestamp in the format requested by
529 \fB\-\-date\fR\&.
530 .RE
531 .sp
532 .RS 4
533 .ie n \{\
534 \h'-04' 4.\h'+01'\c
535 .\}
536 .el \{\
537 .sp -1
538 .IP " 4." 4.2
539 .\}
540 Otherwise, show the index format\&.
541 .RE
542 .sp
543 Under
544 \fB\-\-pretty=oneline\fR, the commit message is prefixed with this information on the same line\&. This option cannot be combined with
545 \fB\-\-reverse\fR\&. See also
546 \fBgit-reflog\fR(1)\&.
547 .sp
548 Under
549 \fB\-\-pretty=reference\fR, this information will not be shown at all\&.
550 .RE
551 .PP
552 \-\-merge
553 .RS 4
554 Show commits touching conflicted paths in the range
555 \fBHEAD\&.\&.\&.<other>\fR, where
556 \fB<other>\fR
557 is the first existing pseudoref in
558 \fBMERGE_HEAD\fR,
559 \fBCHERRY_PICK_HEAD\fR,
560 \fBREVERT_HEAD\fR
561 or
562 \fBREBASE_HEAD\fR\&. Only works when the index has unmerged entries\&. This option can be used to show relevant commits when resolving conflicts from a 3\-way merge\&.
563 .RE
564 .PP
565 \-\-boundary
566 .RS 4
567 Output excluded boundary commits\&. Boundary commits are prefixed with
568 \fB\-\fR\&.
569 .RE
570 .SS "History Simplification"
571 .sp
572 Sometimes you are only interested in parts of the history, for example the commits modifying a particular <path>\&. But there are two parts of \fIHistory Simplification\fR, one part is selecting the commits and the other is how to do it, as there are various strategies to simplify the history\&.
573 .sp
574 The following options select the commits to be shown:
575 .PP
576 <paths>
577 .RS 4
578 Commits modifying the given <paths> are selected\&.
579 .RE
580 .PP
581 \-\-simplify\-by\-decoration
582 .RS 4
583 Commits that are referred by some branch or tag are selected\&.
584 .RE
585 .sp
586 Note that extra commits can be shown to give a meaningful history\&.
587 .sp
588 The following options affect the way the simplification is performed:
589 .PP
590 Default mode
591 .RS 4
592 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)
593 .RE
594 .PP
595 \-\-show\-pulls
596 .RS 4
597 Include all commits from the default mode, but also any merge commits that are not TREESAME to the first parent but are TREESAME to a later parent\&. This mode is helpful for showing the merge commits that "first introduced" a change to a branch\&.
598 .RE
599 .PP
600 \-\-full\-history
601 .RS 4
602 Same as the default mode, but does not prune some history\&.
603 .RE
604 .PP
605 \-\-dense
606 .RS 4
607 Only the selected commits are shown, plus some to have a meaningful history\&.
608 .RE
609 .PP
610 \-\-sparse
611 .RS 4
612 All commits in the simplified history are shown\&.
613 .RE
614 .PP
615 \-\-simplify\-merges
616 .RS 4
617 Additional option to
618 \fB\-\-full\-history\fR
619 to remove some needless merges from the resulting history, as there are no selected commits contributing to this merge\&.
620 .RE
621 .PP
622 \-\-ancestry\-path[=<commit>]
623 .RS 4
624 When given a range of commits to display (e\&.g\&.
625 \fIcommit1\&.\&.commit2\fR
626 or
627 \fIcommit2 ^commit1\fR), only display commits in that range that are ancestors of <commit>, descendants of <commit>, or <commit> itself\&. If no commit is specified, use
628 \fIcommit1\fR
629 (the excluded part of the range) as <commit>\&. Can be passed multiple times; if so, a commit is included if it is any of the commits given or if it is an ancestor or descendant of one of them\&.
630 .RE
631 .sp
632 A more detailed explanation follows\&.
633 .sp
634 Suppose you specified \fBfoo\fR as the <paths>\&. We shall call commits that modify \fBfoo\fR !TREESAME, and the rest TREESAME\&. (In a diff filtered for \fBfoo\fR, they look different and equal, respectively\&.)
635 .sp
636 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 \fBfoo\fR in this commit graph:
637 .sp
638 .if n \{\
639 .RS 4
640 .\}
641 .nf
642 \&.\-A\-\-\-M\-\-\-N\-\-\-O\-\-\-P\-\-\-Q
643 / / / / / /
644 I B C D E Y
645 \e / / / / /
646 `\-\-\-\-\-\-\-\-\-\-\-\-\-\*(Aq X
647 .fi
648 .if n \{\
649 .RE
650 .\}
651 .sp
652 The horizontal line of history A\-\-\-Q is taken to be the first parent of each merge\&. The commits are:
653 .sp
654 .RS 4
655 .ie n \{\
656 \h'-04'\(bu\h'+03'\c
657 .\}
658 .el \{\
659 .sp -1
660 .IP \(bu 2.3
661 .\}
662 \fBI\fR
663 is the initial commit, in which
664 \fBfoo\fR
665 exists with contents
666 \(lqasdf\(rq, and a file
667 \fBquux\fR
668 exists with contents
669 \(lqquux\(rq\&. Initial commits are compared to an empty tree, so
670 \fBI\fR
671 is !TREESAME\&.
672 .RE
673 .sp
674 .RS 4
675 .ie n \{\
676 \h'-04'\(bu\h'+03'\c
677 .\}
678 .el \{\
679 .sp -1
680 .IP \(bu 2.3
681 .\}
682 In
683 \fBA\fR,
684 \fBfoo\fR
685 contains just
686 \(lqfoo\(rq\&.
687 .RE
688 .sp
689 .RS 4
690 .ie n \{\
691 \h'-04'\(bu\h'+03'\c
692 .\}
693 .el \{\
694 .sp -1
695 .IP \(bu 2.3
696 .\}
697 \fBB\fR
698 contains the same change as
699 \fBA\fR\&. Its merge
700 \fBM\fR
701 is trivial and hence TREESAME to all parents\&.
702 .RE
703 .sp
704 .RS 4
705 .ie n \{\
706 \h'-04'\(bu\h'+03'\c
707 .\}
708 .el \{\
709 .sp -1
710 .IP \(bu 2.3
711 .\}
712 \fBC\fR
713 does not change
714 \fBfoo\fR, but its merge
715 \fBN\fR
716 changes it to
717 \(lqfoobar\(rq, so it is not TREESAME to any parent\&.
718 .RE
719 .sp
720 .RS 4
721 .ie n \{\
722 \h'-04'\(bu\h'+03'\c
723 .\}
724 .el \{\
725 .sp -1
726 .IP \(bu 2.3
727 .\}
728 \fBD\fR
729 sets
730 \fBfoo\fR
731 to
732 \(lqbaz\(rq\&. Its merge
733 \fBO\fR
734 combines the strings from
735 \fBN\fR
736 and
737 \fBD\fR
738 to
739 \(lqfoobarbaz\(rq; i\&.e\&., it is not TREESAME to any parent\&.
740 .RE
741 .sp
742 .RS 4
743 .ie n \{\
744 \h'-04'\(bu\h'+03'\c
745 .\}
746 .el \{\
747 .sp -1
748 .IP \(bu 2.3
749 .\}
750 \fBE\fR
751 changes
752 \fBquux\fR
753 to
754 \(lqxyzzy\(rq, and its merge
755 \fBP\fR
756 combines the strings to
757 \(lqquux xyzzy\(rq\&.
758 \fBP\fR
759 is TREESAME to
760 \fBO\fR, but not to
761 \fBE\fR\&.
762 .RE
763 .sp
764 .RS 4
765 .ie n \{\
766 \h'-04'\(bu\h'+03'\c
767 .\}
768 .el \{\
769 .sp -1
770 .IP \(bu 2.3
771 .\}
772 \fBX\fR
773 is an independent root commit that added a new file
774 \fBside\fR, and
775 \fBY\fR
776 modified it\&.
777 \fBY\fR
778 is TREESAME to
779 \fBX\fR\&. Its merge
780 \fBQ\fR
781 added
782 \fBside\fR
783 to
784 \fBP\fR, and
785 \fBQ\fR
786 is TREESAME to
787 \fBP\fR, but not to
788 \fBY\fR\&.
789 .RE
790 .sp
791 \fBrev\-list\fR walks backwards through history, including or excluding commits based on whether \fB\-\-full\-history\fR and/or parent rewriting (via \fB\-\-parents\fR or \fB\-\-children\fR) are used\&. The following settings are available\&.
792 .PP
793 Default mode
794 .RS 4
795 Commits are included if they are not TREESAME to any parent (though this can be changed, see
796 \fB\-\-sparse\fR
797 below)\&. If the 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\&.
798 .sp
799 This results in:
800 .sp
801 .if n \{\
802 .RS 4
803 .\}
804 .nf
805 \&.\-A\-\-\-N\-\-\-O
806 / / /
807 I\-\-\-\-\-\-\-\-\-D
808 .fi
809 .if n \{\
810 .RE
811 .\}
812 .sp
813 Note how the rule to only follow the TREESAME parent, if one is available, removed
814 \fBB\fR
815 from consideration entirely\&.
816 \fBC\fR
817 was considered via
818 \fBN\fR, but is TREESAME\&. Root commits are compared to an empty tree, so
819 \fBI\fR
820 is !TREESAME\&.
821 .sp
822 Parent/child relations are only visible with
823 \fB\-\-parents\fR, but that does not affect the commits selected in default mode, so we have shown the parent lines\&.
824 .RE
825 .PP
826 \-\-full\-history without parent rewriting
827 .RS 4
828 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
829 .sp
830 .if n \{\
831 .RS 4
832 .\}
833 .nf
834 I A B N D O P Q
835 .fi
836 .if n \{\
837 .RE
838 .\}
839 .sp
840 \fBM\fR
841 was excluded because it is TREESAME to both parents\&.
842 \fBE\fR,
843 \fBC\fR
844 and
845 \fBB\fR
846 were all walked, but only
847 \fBB\fR
848 was !TREESAME, so the others do not appear\&.
849 .sp
850 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\&.
851 .RE
852 .PP
853 \-\-full\-history with parent rewriting
854 .RS 4
855 Ordinary commits are only included if they are !TREESAME (though this can be changed, see
856 \fB\-\-sparse\fR
857 below)\&.
858 .sp
859 Merges are always included\&. However, their parent list is rewritten: Along each parent, prune away commits that are not included themselves\&. This results in
860 .sp
861 .if n \{\
862 .RS 4
863 .\}
864 .nf
865 \&.\-A\-\-\-M\-\-\-N\-\-\-O\-\-\-P\-\-\-Q
866 / / / / /
867 I B / D /
868 \e / / / /
869 `\-\-\-\-\-\-\-\-\-\-\-\-\-\*(Aq
870 .fi
871 .if n \{\
872 .RE
873 .\}
874 .sp
875 Compare to
876 \fB\-\-full\-history\fR
877 without rewriting above\&. Note that
878 \fBE\fR
879 was pruned away because it is TREESAME, but the parent list of P was rewritten to contain
880 \fBE\fR\*(Aqs parent
881 \fBI\fR\&. The same happened for
882 \fBC\fR
883 and
884 \fBN\fR, and
885 \fBX\fR,
886 \fBY\fR
887 and
888 \fBQ\fR\&.
889 .RE
890 .sp
891 In addition to the above settings, you can change whether TREESAME affects inclusion:
892 .PP
893 \-\-dense
894 .RS 4
895 Commits that are walked are included if they are not TREESAME to any parent\&.
896 .RE
897 .PP
898 \-\-sparse
899 .RS 4
900 All commits that are walked are included\&.
901 .sp
902 Note that without
903 \fB\-\-full\-history\fR, this still simplifies merges: if one of the parents is TREESAME, we follow only that one, so the other sides of the merge are never walked\&.
904 .RE
905 .PP
906 \-\-simplify\-merges
907 .RS 4
908 First, build a history graph in the same way that
909 \fB\-\-full\-history\fR
910 with parent rewriting does (see above)\&.
911 .sp
912 Then simplify each commit
913 \fBC\fR
914 to its replacement
915 \fBC\*(Aq\fR
916 in the final history according to the following rules:
917 .sp
918 .RS 4
919 .ie n \{\
920 \h'-04'\(bu\h'+03'\c
921 .\}
922 .el \{\
923 .sp -1
924 .IP \(bu 2.3
925 .\}
926 Set
927 \fBC\*(Aq\fR
928 to
929 \fBC\fR\&.
930 .RE
931 .sp
932 .RS 4
933 .ie n \{\
934 \h'-04'\(bu\h'+03'\c
935 .\}
936 .el \{\
937 .sp -1
938 .IP \(bu 2.3
939 .\}
940 Replace each parent
941 \fBP\fR
942 of
943 \fBC\*(Aq\fR
944 with its simplification
945 \fBP\*(Aq\fR\&. In 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\&.
946 .RE
947 .sp
948 .RS 4
949 .ie n \{\
950 \h'-04'\(bu\h'+03'\c
951 .\}
952 .el \{\
953 .sp -1
954 .IP \(bu 2.3
955 .\}
956 If after this parent rewriting,
957 \fBC\*(Aq\fR
958 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\&.
959 .RE
960 .sp
961 The effect of this is best shown by way of comparing to
962 \fB\-\-full\-history\fR
963 with parent rewriting\&. The example turns into:
964 .sp
965 .if n \{\
966 .RS 4
967 .\}
968 .nf
969 \&.\-A\-\-\-M\-\-\-N\-\-\-O
970 / / /
971 I B D
972 \e / /
973 `\-\-\-\-\-\-\-\-\-\*(Aq
974 .fi
975 .if n \{\
976 .RE
977 .\}
978 .sp
979 Note the major differences in
980 \fBN\fR,
981 \fBP\fR, and
982 \fBQ\fR
983 over
984 \fB\-\-full\-history\fR:
985 .sp
986 .RS 4
987 .ie n \{\
988 \h'-04'\(bu\h'+03'\c
989 .\}
990 .el \{\
991 .sp -1
992 .IP \(bu 2.3
993 .\}
994 \fBN\fR\*(Aqs parent list had
995 \fBI\fR
996 removed, because it is an ancestor of the other parent
997 \fBM\fR\&. Still,
998 \fBN\fR
999 remained because it is !TREESAME\&.
1000 .RE
1001 .sp
1002 .RS 4
1003 .ie n \{\
1004 \h'-04'\(bu\h'+03'\c
1005 .\}
1006 .el \{\
1007 .sp -1
1008 .IP \(bu 2.3
1009 .\}
1010 \fBP\fR\*(Aqs parent list similarly had
1011 \fBI\fR
1012 removed\&.
1013 \fBP\fR
1014 was then removed completely, because it had one parent and is TREESAME\&.
1015 .RE
1016 .sp
1017 .RS 4
1018 .ie n \{\
1019 \h'-04'\(bu\h'+03'\c
1020 .\}
1021 .el \{\
1022 .sp -1
1023 .IP \(bu 2.3
1024 .\}
1025 \fBQ\fR\*(Aqs parent list had
1026 \fBY\fR
1027 simplified to
1028 \fBX\fR\&.
1029 \fBX\fR
1030 was then removed, because it was a TREESAME root\&.
1031 \fBQ\fR
1032 was then removed completely, because it had one parent and is TREESAME\&.
1033 .RE
1034 .RE
1035 .sp
1036 There is another simplification mode available:
1037 .PP
1038 \-\-ancestry\-path[=<commit>]
1039 .RS 4
1040 Limit the displayed commits to those which are an ancestor of <commit>, or which are a descendant of <commit>, or are <commit> itself\&.
1041 .sp
1042 As an example use case, consider the following commit history:
1043 .sp
1044 .if n \{\
1045 .RS 4
1046 .\}
1047 .nf
1048 D\-\-\-E\-\-\-\-\-\-\-F
1049 / \e \e
1050 B\-\-\-C\-\-\-G\-\-\-H\-\-\-I\-\-\-J
1051 / \e
1052 A\-\-\-\-\-\-\-K\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-L\-\-M
1053 .fi
1054 .if n \{\
1055 .RE
1056 .\}
1057 .sp
1058 A regular
1059 \fID\&.\&.M\fR
1060 computes the set of commits that are ancestors of
1061 \fBM\fR, but excludes the ones that are ancestors of
1062 \fBD\fR\&. This is useful to see what happened to the history leading to
1063 \fBM\fR
1064 since
1065 \fBD\fR, in the sense that
1066 \(lqwhat does \fBM\fR have that did not exist in \fBD\fR\(rq\&. The result in this example would be all the commits, except
1067 \fBA\fR
1068 and
1069 \fBB\fR
1070 (and
1071 \fBD\fR
1072 itself, of course)\&.
1073 .sp
1074 When we want to find out what commits in
1075 \fBM\fR
1076 are contaminated with the bug introduced by
1077 \fBD\fR
1078 and need fixing, however, we might want to view only the subset of
1079 \fID\&.\&.M\fR
1080 that are actually descendants of
1081 \fBD\fR, i\&.e\&. excluding
1082 \fBC\fR
1083 and
1084 \fBK\fR\&. This is exactly what the
1085 \fB\-\-ancestry\-path\fR
1086 option does\&. Applied to the
1087 \fID\&.\&.M\fR
1088 range, it results in:
1089 .sp
1090 .if n \{\
1091 .RS 4
1092 .\}
1093 .nf
1094 E\-\-\-\-\-\-\-F
1095 \e \e
1096 G\-\-\-H\-\-\-I\-\-\-J
1097 \e
1098 L\-\-M
1099 .fi
1100 .if n \{\
1101 .RE
1102 .\}
1103 .sp
1104 We can also use
1105 \fB\-\-ancestry\-path=D\fR
1106 instead of
1107 \fB\-\-ancestry\-path\fR
1108 which means the same thing when applied to the
1109 \fID\&.\&.M\fR
1110 range but is just more explicit\&.
1111 .sp
1112 If we instead are interested in a given topic within this range, and all commits affected by that topic, we may only want to view the subset of
1113 \fBD\&.\&.M\fR
1114 which contain that topic in their ancestry path\&. So, using
1115 \fB\-\-ancestry\-path=H D\&.\&.M\fR
1116 for example would result in:
1117 .sp
1118 .if n \{\
1119 .RS 4
1120 .\}
1121 .nf
1122 E
1123 \e
1124 G\-\-\-H\-\-\-I\-\-\-J
1125 \e
1126 L\-\-M
1127 .fi
1128 .if n \{\
1129 .RE
1130 .\}
1131 .sp
1132 Whereas
1133 \fB\-\-ancestry\-path=K D\&.\&.M\fR
1134 would result in
1135 .sp
1136 .if n \{\
1137 .RS 4
1138 .\}
1139 .nf
1140 K\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-L\-\-M
1141 .fi
1142 .if n \{\
1143 .RE
1144 .\}
1145 .RE
1146 .sp
1147 Before discussing another option, \fB\-\-show\-pulls\fR, we need to create a new example history\&.
1148 .sp
1149 A common problem users face when looking at simplified history is that a commit they know changed a file somehow does not appear in the file\(cqs simplified history\&. Let\(cqs demonstrate a new example and show how options such as \fB\-\-full\-history\fR and \fB\-\-simplify\-merges\fR works in that case:
1150 .sp
1151 .if n \{\
1152 .RS 4
1153 .\}
1154 .nf
1155 \&.\-A\-\-\-M\-\-\-\-\-C\-\-N\-\-\-O\-\-\-P
1156 / / \e \e \e/ / /
1157 I B \e R\-\*(Aq`\-Z\*(Aq /
1158 \e / \e/ /
1159 \e / /\e /
1160 `\-\-\-X\-\-\*(Aq `\-\-\-Y\-\-\*(Aq
1161 .fi
1162 .if n \{\
1163 .RE
1164 .\}
1165 .sp
1166 For this example, suppose \fBI\fR created \fBfile\&.txt\fR which was modified by \fBA\fR, \fBB\fR, and \fBX\fR in different ways\&. The single\-parent commits \fBC\fR, \fBZ\fR, and \fBY\fR do not change \fBfile\&.txt\fR\&. The merge commit \fBM\fR was created by resolving the merge conflict to include both changes from \fBA\fR and \fBB\fR and hence is not TREESAME to either\&. The merge commit \fBR\fR, however, was created by ignoring the contents of \fBfile\&.txt\fR at \fBM\fR and taking only the contents of \fBfile\&.txt\fR at \fBX\fR\&. Hence, \fBR\fR is TREESAME to \fBX\fR but not \fBM\fR\&. Finally, the natural merge resolution to create \fBN\fR is to take the contents of \fBfile\&.txt\fR at \fBR\fR, so \fBN\fR is TREESAME to \fBR\fR but not \fBC\fR\&. The merge commits \fBO\fR and \fBP\fR are TREESAME to their first parents, but not to their second parents, \fBZ\fR and \fBY\fR respectively\&.
1167 .sp
1168 When using the default mode, \fBN\fR and \fBR\fR both have a TREESAME parent, so those edges are walked and the others are ignored\&. The resulting history graph is:
1169 .sp
1170 .if n \{\
1171 .RS 4
1172 .\}
1173 .nf
1174 I\-\-\-X
1175 .fi
1176 .if n \{\
1177 .RE
1178 .\}
1179 .sp
1180 When using \fB\-\-full\-history\fR, Git walks every edge\&. This will discover the commits \fBA\fR and \fBB\fR and the merge \fBM\fR, but also will reveal the merge commits \fBO\fR and \fBP\fR\&. With parent rewriting, the resulting graph is:
1181 .sp
1182 .if n \{\
1183 .RS 4
1184 .\}
1185 .nf
1186 \&.\-A\-\-\-M\-\-\-\-\-\-\-\-N\-\-\-O\-\-\-P
1187 / / \e \e \e/ / /
1188 I B \e R\-\*(Aq`\-\-\*(Aq /
1189 \e / \e/ /
1190 \e / /\e /
1191 `\-\-\-X\-\-\*(Aq `\-\-\-\-\-\-\*(Aq
1192 .fi
1193 .if n \{\
1194 .RE
1195 .\}
1196 .sp
1197 Here, the merge commits \fBO\fR and \fBP\fR contribute extra noise, as they did not actually contribute a change to \fBfile\&.txt\fR\&. They only merged a topic that was based on an older version of \fBfile\&.txt\fR\&. This is a common issue in repositories using a workflow where many contributors work in parallel and merge their topic branches along a single trunk: many unrelated merges appear in the \fB\-\-full\-history\fR results\&.
1198 .sp
1199 When using the \fB\-\-simplify\-merges\fR option, the commits \fBO\fR and \fBP\fR disappear from the results\&. This is because the rewritten second parents of \fBO\fR and \fBP\fR are reachable from their first parents\&. Those edges are removed and then the commits look like single\-parent commits that are TREESAME to their parent\&. This also happens to the commit \fBN\fR, resulting in a history view as follows:
1200 .sp
1201 .if n \{\
1202 .RS 4
1203 .\}
1204 .nf
1205 \&.\-A\-\-\-M\-\-\&.
1206 / / \e
1207 I B R
1208 \e / /
1209 \e / /
1210 `\-\-\-X\-\-\*(Aq
1211 .fi
1212 .if n \{\
1213 .RE
1214 .\}
1215 .sp
1216 In this view, we see all of the important single\-parent changes from \fBA\fR, \fBB\fR, and \fBX\fR\&. We also see the carefully\-resolved merge \fBM\fR and the not\-so\-carefully\-resolved merge \fBR\fR\&. This is usually enough information to determine why the commits \fBA\fR and \fBB\fR "disappeared" from history in the default view\&. However, there are a few issues with this approach\&.
1217 .sp
1218 The first issue is performance\&. Unlike any previous option, the \fB\-\-simplify\-merges\fR option requires walking the entire commit history before returning a single result\&. This can make the option difficult to use for very large repositories\&.
1219 .sp
1220 The second issue is one of auditing\&. When many contributors are working on the same repository, it is important which merge commits introduced a change into an important branch\&. The problematic merge \fBR\fR above is not likely to be the merge commit that was used to merge into an important branch\&. Instead, the merge \fBN\fR was used to merge \fBR\fR and \fBX\fR into the important branch\&. This commit may have information about why the change \fBX\fR came to override the changes from \fBA\fR and \fBB\fR in its commit message\&.
1221 .PP
1222 \-\-show\-pulls
1223 .RS 4
1224 In addition to the commits shown in the default history, show each merge commit that is not TREESAME to its first parent but is TREESAME to a later parent\&.
1225 .sp
1226 When a merge commit is included by
1227 \fB\-\-show\-pulls\fR, the merge is treated as if it "pulled" the change from another branch\&. When using
1228 \fB\-\-show\-pulls\fR
1229 on this example (and no other options) the resulting graph is:
1230 .sp
1231 .if n \{\
1232 .RS 4
1233 .\}
1234 .nf
1235 I\-\-\-X\-\-\-R\-\-\-N
1236 .fi
1237 .if n \{\
1238 .RE
1239 .\}
1240 .sp
1241 Here, the merge commits
1242 \fBR\fR
1243 and
1244 \fBN\fR
1245 are included because they pulled the commits
1246 \fBX\fR
1247 and
1248 \fBR\fR
1249 into the base branch, respectively\&. These merges are the reason the commits
1250 \fBA\fR
1251 and
1252 \fBB\fR
1253 do not appear in the default history\&.
1254 .sp
1255 When
1256 \fB\-\-show\-pulls\fR
1257 is paired with
1258 \fB\-\-simplify\-merges\fR, the graph includes all of the necessary information:
1259 .sp
1260 .if n \{\
1261 .RS 4
1262 .\}
1263 .nf
1264 \&.\-A\-\-\-M\-\-\&. N
1265 / / \e /
1266 I B R
1267 \e / /
1268 \e / /
1269 `\-\-\-X\-\-\*(Aq
1270 .fi
1271 .if n \{\
1272 .RE
1273 .\}
1274 .sp
1275 Notice that since
1276 \fBM\fR
1277 is reachable from
1278 \fBR\fR, the edge from
1279 \fBN\fR
1280 to
1281 \fBM\fR
1282 was simplified away\&. However,
1283 \fBN\fR
1284 still appears in the history as an important commit because it "pulled" the change
1285 \fBR\fR
1286 into the main branch\&.
1287 .RE
1288 .sp
1289 The \fB\-\-simplify\-by\-decoration\fR option allows you to view only the 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)\&.
1290 .SS "Commit Ordering"
1291 .sp
1292 By default, the commits are shown in reverse chronological order\&.
1293 .PP
1294 \-\-date\-order
1295 .RS 4
1296 Show no parents before all of its children are shown, but otherwise show commits in the commit timestamp order\&.
1297 .RE
1298 .PP
1299 \-\-author\-date\-order
1300 .RS 4
1301 Show no parents before all of its children are shown, but otherwise show commits in the author timestamp order\&.
1302 .RE
1303 .PP
1304 \-\-topo\-order
1305 .RS 4
1306 Show no parents before all of its children are shown, and avoid showing commits on multiple lines of history intermixed\&.
1307 .sp
1308 For example, in a commit history like this:
1309 .sp
1310 .if n \{\
1311 .RS 4
1312 .\}
1313 .nf
1314 \-\-\-1\-\-\-\-2\-\-\-\-4\-\-\-\-7
1315 \e \e
1316 3\-\-\-\-5\-\-\-\-6\-\-\-\-8\-\-\-
1317 .fi
1318 .if n \{\
1319 .RE
1320 .\}
1321 .sp
1322 where the numbers denote the order of commit timestamps,
1323 \fBgit rev\-list\fR
1324 and friends with
1325 \fB\-\-date\-order\fR
1326 show the commits in the timestamp order: 8 7 6 5 4 3 2 1\&.
1327 .sp
1328 With
1329 \fB\-\-topo\-order\fR, 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\&.
1330 .RE
1331 .PP
1332 \-\-reverse
1333 .RS 4
1334 Output the commits chosen to be shown (see Commit Limiting section above) in reverse order\&. Cannot be combined with
1335 \fB\-\-walk\-reflogs\fR\&.
1336 .RE
1337 .SS "Object Traversal"
1338 .sp
1339 These options are mostly targeted for packing of Git repositories\&.
1340 .PP
1341 \-\-no\-walk[=(sorted|unsorted)]
1342 .RS 4
1343 Only show the given commits, but do not traverse their ancestors\&. This has no effect if a range is specified\&. If the argument
1344 \fBunsorted\fR
1345 is given, the commits are shown in the order they were given on the command line\&. Otherwise (if
1346 \fBsorted\fR
1347 or no argument was given), the commits are shown in reverse chronological order by commit time\&. Cannot be combined with
1348 \fB\-\-graph\fR\&.
1349 .RE
1350 .PP
1351 \-\-do\-walk
1352 .RS 4
1353 Overrides a previous
1354 \fB\-\-no\-walk\fR\&.
1355 .RE
1356 .SS "Commit Formatting"
1357 .PP
1358 \-\-pretty[=<format>], \-\-format=<format>
1359 .RS 4
1360 Pretty\-print the contents of the commit logs in a given format, where
1361 \fI<format>\fR
1362 can be one of
1363 \fIoneline\fR,
1364 \fIshort\fR,
1365 \fImedium\fR,
1366 \fIfull\fR,
1367 \fIfuller\fR,
1368 \fIreference\fR,
1369 \fIemail\fR,
1370 \fIraw\fR,
1371 \fIformat:<string>\fR
1372 and
1373 \fItformat:<string>\fR\&. When
1374 \fI<format>\fR
1375 is none of the above, and has
1376 \fI%placeholder\fR
1377 in it, it acts as if
1378 \fI\-\-pretty=tformat:<format>\fR
1379 were given\&.
1380 .sp
1381 See the "PRETTY FORMATS" section for some additional details for each format\&. When
1382 \fI=<format>\fR
1383 part is omitted, it defaults to
1384 \fImedium\fR\&.
1385 .sp
1386 Note: you can specify the default pretty format in the repository configuration (see
1387 \fBgit-config\fR(1))\&.
1388 .RE
1389 .PP
1390 \-\-abbrev\-commit
1391 .RS 4
1392 Instead of showing the full 40\-byte hexadecimal commit object name, show a prefix that names the object uniquely\&. "\-\-abbrev=<n>" (which also modifies diff output, if it is displayed) option can be used to specify the minimum length of the prefix\&.
1393 .sp
1394 This should make "\-\-pretty=oneline" a whole lot more readable for people using 80\-column terminals\&.
1395 .RE
1396 .PP
1397 \-\-no\-abbrev\-commit
1398 .RS 4
1399 Show the full 40\-byte hexadecimal commit object name\&. This negates
1400 \fB\-\-abbrev\-commit\fR, either explicit or implied by other options such as "\-\-oneline"\&. It also overrides the
1401 \fBlog\&.abbrevCommit\fR
1402 variable\&.
1403 .RE
1404 .PP
1405 \-\-oneline
1406 .RS 4
1407 This is a shorthand for "\-\-pretty=oneline \-\-abbrev\-commit" used together\&.
1408 .RE
1409 .PP
1410 \-\-encoding=<encoding>
1411 .RS 4
1412 Commit objects record the character encoding used for the log message in their encoding header; this option can be used to tell the command to re\-code the commit log message in the encoding preferred by the user\&. For non plumbing commands this defaults to UTF\-8\&. Note that if an object claims to be encoded in
1413 \fBX\fR
1414 and we are outputting in
1415 \fBX\fR, we will output the object verbatim; this means that invalid sequences in the original commit may be copied to the output\&. Likewise, if iconv(3) fails to convert the commit, we will quietly output the original object verbatim\&.
1416 .RE
1417 .PP
1418 \-\-expand\-tabs=<n>, \-\-expand\-tabs, \-\-no\-expand\-tabs
1419 .RS 4
1420 Perform a tab expansion (replace each tab with enough spaces to fill to the next display column that is a multiple of
1421 \fI<n>\fR) in the log message before showing it in the output\&.
1422 \fB\-\-expand\-tabs\fR
1423 is a short\-hand for
1424 \fB\-\-expand\-tabs=8\fR, and
1425 \fB\-\-no\-expand\-tabs\fR
1426 is a short\-hand for
1427 \fB\-\-expand\-tabs=0\fR, which disables tab expansion\&.
1428 .sp
1429 By default, tabs are expanded in pretty formats that indent the log message by 4 spaces (i\&.e\&.
1430 \fImedium\fR, which is the default,
1431 \fIfull\fR, and
1432 \fIfuller\fR)\&.
1433 .RE
1434 .PP
1435 \-\-notes[=<ref>]
1436 .RS 4
1437 Show the notes (see
1438 \fBgit-notes\fR(1)) that annotate the commit, when showing the commit log message\&. This is the default for
1439 \fBgit log\fR,
1440 \fBgit show\fR
1441 and
1442 \fBgit whatchanged\fR
1443 commands when there is no
1444 \fB\-\-pretty\fR,
1445 \fB\-\-format\fR, or
1446 \fB\-\-oneline\fR
1447 option given on the command line\&.
1448 .sp
1449 By default, the notes shown are from the notes refs listed in the
1450 \fBcore\&.notesRef\fR
1451 and
1452 \fBnotes\&.displayRef\fR
1453 variables (or corresponding environment overrides)\&. See
1454 \fBgit-config\fR(1)
1455 for more details\&.
1456 .sp
1457 With an optional
1458 \fI<ref>\fR
1459 argument, use the ref to find the notes to display\&. The ref can specify the full refname when it begins with
1460 \fBrefs/notes/\fR; when it begins with
1461 \fBnotes/\fR,
1462 \fBrefs/\fR
1463 and otherwise
1464 \fBrefs/notes/\fR
1465 is prefixed to form the full name of the ref\&.
1466 .sp
1467 Multiple \-\-notes options can be combined to control which notes are being displayed\&. Examples: "\-\-notes=foo" will show only notes from "refs/notes/foo"; "\-\-notes=foo \-\-notes" will show both notes from "refs/notes/foo" and from the default notes ref(s)\&.
1468 .RE
1469 .PP
1470 \-\-no\-notes
1471 .RS 4
1472 Do not show notes\&. This negates the above
1473 \fB\-\-notes\fR
1474 option, by resetting the list of notes refs from which notes are shown\&. Options are parsed in the order given on the command line, so e\&.g\&. "\-\-notes \-\-notes=foo \-\-no\-notes \-\-notes=bar" will only show notes from "refs/notes/bar"\&.
1475 .RE
1476 .PP
1477 \-\-show\-notes\-by\-default
1478 .RS 4
1479 Show the default notes unless options for displaying specific notes are given\&.
1480 .RE
1481 .PP
1482 \-\-show\-notes[=<ref>], \-\-[no\-]standard\-notes
1483 .RS 4
1484 These options are deprecated\&. Use the above \-\-notes/\-\-no\-notes options instead\&.
1485 .RE
1486 .PP
1487 \-\-show\-signature
1488 .RS 4
1489 Check the validity of a signed commit object by passing the signature to
1490 \fBgpg \-\-verify\fR
1491 and show the output\&.
1492 .RE
1493 .PP
1494 \-\-relative\-date
1495 .RS 4
1496 Synonym for
1497 \fB\-\-date=relative\fR\&.
1498 .RE
1499 .PP
1500 \-\-date=<format>
1501 .RS 4
1502 Only takes effect for dates shown in human\-readable format, such as when using
1503 \fB\-\-pretty\fR\&.
1504 \fBlog\&.date\fR
1505 config variable sets a default value for the log command\(cqs
1506 \fB\-\-date\fR
1507 option\&. By default, dates are shown in the original time zone (either committer\(cqs or author\(cqs)\&. If
1508 \fB\-local\fR
1509 is appended to the format (e\&.g\&.,
1510 \fBiso\-local\fR), the user\(cqs local time zone is used instead\&.
1511 .sp
1512 \fB\-\-date=relative\fR
1513 shows dates relative to the current time, e\&.g\&.
1514 \(lq2 hours ago\(rq\&. The
1515 \fB\-local\fR
1516 option has no effect for
1517 \fB\-\-date=relative\fR\&.
1518 .sp
1519 \fB\-\-date=local\fR
1520 is an alias for
1521 \fB\-\-date=default\-local\fR\&.
1522 .sp
1523 \fB\-\-date=iso\fR
1524 (or
1525 \fB\-\-date=iso8601\fR) shows timestamps in a ISO 8601\-like format\&. The differences to the strict ISO 8601 format are:
1526 .sp
1527 .RS 4
1528 .ie n \{\
1529 \h'-04'\(bu\h'+03'\c
1530 .\}
1531 .el \{\
1532 .sp -1
1533 .IP \(bu 2.3
1534 .\}
1535 a space instead of the
1536 \fBT\fR
1537 date/time delimiter
1538 .RE
1539 .sp
1540 .RS 4
1541 .ie n \{\
1542 \h'-04'\(bu\h'+03'\c
1543 .\}
1544 .el \{\
1545 .sp -1
1546 .IP \(bu 2.3
1547 .\}
1548 a space between time and time zone
1549 .RE
1550 .sp
1551 .RS 4
1552 .ie n \{\
1553 \h'-04'\(bu\h'+03'\c
1554 .\}
1555 .el \{\
1556 .sp -1
1557 .IP \(bu 2.3
1558 .\}
1559 no colon between hours and minutes of the time zone
1560 .RE
1561 .sp
1562 \fB\-\-date=iso\-strict\fR
1563 (or
1564 \fB\-\-date=iso8601\-strict\fR) shows timestamps in strict ISO 8601 format\&.
1565 .sp
1566 \fB\-\-date=rfc\fR
1567 (or
1568 \fB\-\-date=rfc2822\fR) shows timestamps in RFC 2822 format, often found in email messages\&.
1569 .sp
1570 \fB\-\-date=short\fR
1571 shows only the date, but not the time, in
1572 \fBYYYY\-MM\-DD\fR
1573 format\&.
1574 .sp
1575 \fB\-\-date=raw\fR
1576 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
1577 \fB+\fR
1578 or
1579 \fB\-\fR
1580 with four digits; the first two are hours, and the second two are minutes)\&. I\&.e\&., as if the timestamp were formatted with
1581 \fBstrftime("%s %z")\fR)\&. Note that the
1582 \fB\-local\fR
1583 option does not affect the seconds\-since\-epoch value (which is always measured in UTC), but does switch the accompanying timezone value\&.
1584 .sp
1585 \fB\-\-date=human\fR
1586 shows the timezone if the timezone does not match the current time\-zone, and doesn\(cqt 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\(cqs in the last few days and we can just say what weekday it was)\&. For older dates the hour and minute is also omitted\&.
1587 .sp
1588 \fB\-\-date=unix\fR
1589 shows the date as a Unix epoch timestamp (seconds since 1970)\&. As with
1590 \fB\-\-raw\fR, this is always in UTC and therefore
1591 \fB\-local\fR
1592 has no effect\&.
1593 .sp
1594 \fB\-\-date=format:\&.\&.\&.\fR
1595 feeds the format
1596 \fB\&.\&.\&.\fR
1597 to your system
1598 \fBstrftime\fR, except for %s, %z, and %Z, which are handled internally\&. Use
1599 \fB\-\-date=format:%c\fR
1600 to show the date in your system locale\(cqs preferred format\&. See the
1601 \fBstrftime\fR
1602 manual for a complete list of format placeholders\&. When using
1603 \fB\-local\fR, the correct syntax is
1604 \fB\-\-date=format\-local:\&.\&.\&.\fR\&.
1605 .sp
1606 \fB\-\-date=default\fR
1607 is the default format, and is based on ctime(3) output\&. It shows a single line with three\-letter day of the week, three\-letter month, day\-of\-month, hour\-minute\-seconds in "HH:MM:SS" format, followed by 4\-digit year, plus timezone information, unless the local time zone is used, e\&.g\&.
1608 \fBThu Jan 1 00:00:00 1970 +0000\fR\&.
1609 .RE
1610 .PP
1611 \-\-parents
1612 .RS 4
1613 Print also the parents of the commit (in the form "commit parent\&...\:")\&. Also enables parent rewriting, see
1614 \fIHistory Simplification\fR
1615 above\&.
1616 .RE
1617 .PP
1618 \-\-children
1619 .RS 4
1620 Print also the children of the commit (in the form "commit child\&...\:")\&. Also enables parent rewriting, see
1621 \fIHistory Simplification\fR
1622 above\&.
1623 .RE
1624 .PP
1625 \-\-left\-right
1626 .RS 4
1627 Mark which side of a symmetric difference a commit is reachable from\&. Commits from the left side are prefixed with
1628 \fB<\fR
1629 and those from the right with
1630 \fB>\fR\&. If combined with
1631 \fB\-\-boundary\fR, those commits are prefixed with
1632 \fB\-\fR\&.
1633 .sp
1634 For example, if you have this topology:
1635 .sp
1636 .if n \{\
1637 .RS 4
1638 .\}
1639 .nf
1640 y\-\-\-b\-\-\-b branch B
1641 / \e /
1642 / \&.
1643 / / \e
1644 o\-\-\-x\-\-\-a\-\-\-a branch A
1645 .fi
1646 .if n \{\
1647 .RE
1648 .\}
1649 .sp
1650 you would get an output like this:
1651 .sp
1652 .if n \{\
1653 .RS 4
1654 .\}
1655 .nf
1656 $ git rev\-list \-\-left\-right \-\-boundary \-\-pretty=oneline A\&.\&.\&.B
1658 >bbbbbbb\&.\&.\&. 3rd on b
1659 >bbbbbbb\&.\&.\&. 2nd on b
1660 <aaaaaaa\&.\&.\&. 3rd on a
1661 <aaaaaaa\&.\&.\&. 2nd on a
1662 \-yyyyyyy\&.\&.\&. 1st on b
1663 \-xxxxxxx\&.\&.\&. 1st on a
1664 .fi
1665 .if n \{\
1666 .RE
1667 .\}
1668 .RE
1669 .PP
1670 \-\-graph
1671 .RS 4
1672 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\&. Cannot be combined with
1673 \fB\-\-no\-walk\fR\&.
1674 .sp
1675 This enables parent rewriting, see
1676 \fIHistory Simplification\fR
1677 above\&.
1678 .sp
1679 This implies the
1680 \fB\-\-topo\-order\fR
1681 option by default, but the
1682 \fB\-\-date\-order\fR
1683 option may also be specified\&.
1684 .RE
1685 .PP
1686 \-\-show\-linear\-break[=<barrier>]
1687 .RS 4
1688 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
1689 \fB<barrier>\fR
1690 is specified, it is the string that will be shown instead of the default one\&.
1691 .RE
1692 .SH "OUTPUT"
1693 .sp
1694 When there are no conflicts, the output of this command is usable as input to \fBgit update\-ref \-\-stdin\fR\&. It is of the form:
1695 .sp
1696 .if n \{\
1697 .RS 4
1698 .\}
1699 .nf
1700 update refs/heads/branch1 ${NEW_branch1_HASH} ${OLD_branch1_HASH}
1701 update refs/heads/branch2 ${NEW_branch2_HASH} ${OLD_branch2_HASH}
1702 update refs/heads/branch3 ${NEW_branch3_HASH} ${OLD_branch3_HASH}
1703 .fi
1704 .if n \{\
1705 .RE
1706 .\}
1707 .sp
1708 where the number of refs updated depends on the arguments passed and the shape of the history being replayed\&. When using \fB\-\-advance\fR, the number of refs updated is always one, but for \fB\-\-onto\fR, it can be one or more (rebasing multiple branches simultaneously is supported)\&.
1709 .SH "EXIT STATUS"
1710 .sp
1711 For a successful, non\-conflicted replay, the exit status is 0\&. When the replay has conflicts, the exit status is 1\&. If the replay is not able to complete (or start) due to some kind of error, the exit status is something other than 0 or 1\&.
1712 .SH "EXAMPLES"
1713 .sp
1714 To simply rebase \fBmybranch\fR onto \fBtarget\fR:
1715 .sp
1716 .if n \{\
1717 .RS 4
1718 .\}
1719 .nf
1720 $ git replay \-\-onto target origin/main\&.\&.mybranch
1721 update refs/heads/mybranch ${NEW_mybranch_HASH} ${OLD_mybranch_HASH}
1722 .fi
1723 .if n \{\
1724 .RE
1725 .\}
1726 .sp
1727 To cherry\-pick the commits from mybranch onto target:
1728 .sp
1729 .if n \{\
1730 .RS 4
1731 .\}
1732 .nf
1733 $ git replay \-\-advance target origin/main\&.\&.mybranch
1734 update refs/heads/target ${NEW_target_HASH} ${OLD_target_HASH}
1735 .fi
1736 .if n \{\
1737 .RE
1738 .\}
1739 .sp
1740 Note that the first two examples replay the exact same commits and on top of the exact same new base, they only differ in that the first provides instructions to make mybranch point at the new commits and the second provides instructions to make target point at them\&.
1741 .sp
1742 What if you have a stack of branches, one depending upon another, and you\(cqd really like to rebase the whole set?
1743 .sp
1744 .if n \{\
1745 .RS 4
1746 .\}
1747 .nf
1748 $ git replay \-\-contained \-\-onto origin/main origin/main\&.\&.tipbranch
1749 update refs/heads/branch1 ${NEW_branch1_HASH} ${OLD_branch1_HASH}
1750 update refs/heads/branch2 ${NEW_branch2_HASH} ${OLD_branch2_HASH}
1751 update refs/heads/tipbranch ${NEW_tipbranch_HASH} ${OLD_tipbranch_HASH}
1752 .fi
1753 .if n \{\
1754 .RE
1755 .\}
1756 .sp
1757 When calling \fBgit replay\fR, one does not need to specify a range of commits to replay using the syntax \fBA\&.\&.B\fR; any range expression will do:
1758 .sp
1759 .if n \{\
1760 .RS 4
1761 .\}
1762 .nf
1763 $ git replay \-\-onto origin/main ^base branch1 branch2 branch3
1764 update refs/heads/branch1 ${NEW_branch1_HASH} ${OLD_branch1_HASH}
1765 update refs/heads/branch2 ${NEW_branch2_HASH} ${OLD_branch2_HASH}
1766 update refs/heads/branch3 ${NEW_branch3_HASH} ${OLD_branch3_HASH}
1767 .fi
1768 .if n \{\
1769 .RE
1770 .\}
1771 .sp
1772 This will simultaneously rebase \fBbranch1\fR, \fBbranch2\fR, and \fBbranch3\fR, all commits they have since \fBbase\fR, playing them on top of \fBorigin/main\fR\&. These three branches may have commits on top of \fBbase\fR that they have in common, but that does not need to be the case\&.
1773 .SH "GIT"
1774 .sp
1775 Part of the \fBgit\fR(1) suite