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