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