Autogenerated manpages for v2.36.1-153-gf9b95
[git-manpages.git] / man1 / git-shortlog.1
blobed32d4ebb053b76347205ae6e4c74a9e472bae8b
1 '\" t
2 .\"     Title: git-shortlog
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: 05/20/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.36.1.153.gf9b95943b6
8 .\"  Language: English
9 .\"
10 .TH "GIT\-SHORTLOG" "1" "05/20/2022" "Git 2\&.36\&.1\&.153\&.gf9b959" "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-shortlog \- Summarize \(aqgit log\(aq output
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit shortlog\fR [<options>] [<revision\-range>] [[\-\-] <path>\&...]
36 git log \-\-pretty=short | \fIgit shortlog\fR [<options>]
37 .fi
38 .sp
39 .SH "DESCRIPTION"
40 .sp
41 Summarizes \fIgit log\fR output in a format suitable for inclusion in release announcements\&. Each commit will be grouped by author and title\&.
42 .sp
43 Additionally, "[PATCH]" will be stripped from the commit description\&.
44 .sp
45 If no revisions are passed on the command line and either standard input is not a terminal or there is no current branch, \fIgit shortlog\fR will output a summary of the log read from standard input, without reference to the current repository\&.
46 .SH "OPTIONS"
47 .PP
48 \-n, \-\-numbered
49 .RS 4
50 Sort output according to the number of commits per author instead of author alphabetic order\&.
51 .RE
52 .PP
53 \-s, \-\-summary
54 .RS 4
55 Suppress commit description and provide a commit count summary only\&.
56 .RE
57 .PP
58 \-e, \-\-email
59 .RS 4
60 Show the email address of each author\&.
61 .RE
62 .PP
63 \-\-format[=<format>]
64 .RS 4
65 Instead of the commit subject, use some other information to describe each commit\&.
66 \fI<format>\fR
67 can be any string accepted by the
68 \fB\-\-format\fR
69 option of
70 \fIgit log\fR, such as
71 \fI* [%h] %s\fR\&. (See the "PRETTY FORMATS" section of
72 \fBgit-log\fR(1)\&.)
73 .sp
74 .if n \{\
75 .RS 4
76 .\}
77 .nf
78 Each pretty\-printed commit will be rewrapped before it is shown\&.
79 .fi
80 .if n \{\
81 .RE
82 .\}
83 .RE
84 .PP
85 \-\-group=<type>
86 .RS 4
87 Group commits based on
88 \fB<type>\fR\&. If no
89 \fB\-\-group\fR
90 option is specified, the default is
91 \fBauthor\fR\&.
92 \fB<type>\fR
93 is one of:
94 .sp
95 .RS 4
96 .ie n \{\
97 \h'-04'\(bu\h'+03'\c
98 .\}
99 .el \{\
100 .sp -1
101 .IP \(bu 2.3
103 \fBauthor\fR, commits are grouped by author
106 .RS 4
107 .ie n \{\
108 \h'-04'\(bu\h'+03'\c
110 .el \{\
111 .sp -1
112 .IP \(bu 2.3
114 \fBcommitter\fR, commits are grouped by committer (the same as
115 \fB\-c\fR)
118 .RS 4
119 .ie n \{\
120 \h'-04'\(bu\h'+03'\c
122 .el \{\
123 .sp -1
124 .IP \(bu 2.3
126 \fBtrailer:<field>\fR, the
127 \fB<field>\fR
128 is interpreted as a case\-insensitive commit message trailer (see
129 \fBgit-interpret-trailers\fR(1))\&. For example, if your project uses
130 \fBReviewed\-by\fR
131 trailers, you might want to see who has been reviewing with
132 \fBgit shortlog \-ns \-\-group=trailer:reviewed\-by\fR\&.
134 Note that commits that do not include the trailer will not be counted\&. Likewise, commits with multiple trailers (e\&.g\&., multiple signoffs) may be counted more than once (but only once per unique trailer value in that commit)\&.
136 Shortlog will attempt to parse each trailer value as a
137 \fBname <email>\fR
138 identity\&. If successful, the mailmap is applied and the email is omitted unless the
139 \fB\-\-email\fR
140 option is specified\&. If the value cannot be parsed as an identity, it will be taken literally and completely\&.
144 \fB\-\-group\fR
145 is specified multiple times, commits are counted under each value (but again, only once per unique value in that commit)\&. For example,
146 \fBgit shortlog \-\-group=author \-\-group=trailer:co\-authored\-by\fR
147 counts both authors and co\-authors\&.
150 \-c, \-\-committer
151 .RS 4
152 This is an alias for
153 \fB\-\-group=committer\fR\&.
156 \-w[<width>[,<indent1>[,<indent2>]]]
157 .RS 4
158 Linewrap the output by wrapping each line at
159 \fBwidth\fR\&. The first line of each entry is indented by
160 \fBindent1\fR
161 spaces, and the second and subsequent lines are indented by
162 \fBindent2\fR
163 spaces\&.
164 \fBwidth\fR,
165 \fBindent1\fR, and
166 \fBindent2\fR
167 default to 76, 6 and 9 respectively\&.
169 If width is
170 \fB0\fR
171 (zero) then indent the lines of the output without wrapping them\&.
174 <revision\-range>
175 .RS 4
176 Show only commits in the specified revision range\&. When no <revision\-range> is specified, it defaults to
177 \fBHEAD\fR
178 (i\&.e\&. the whole history leading to the current commit)\&.
179 \fBorigin\&.\&.HEAD\fR
180 specifies all the commits reachable from the current commit (i\&.e\&.
181 \fBHEAD\fR), but not from
182 \fBorigin\fR\&. For a complete list of ways to spell <revision\-range>, see the "Specifying Ranges" section of
183 \fBgitrevisions\fR(7)\&.
186 [\-\-] <path>\&...
187 .RS 4
188 Consider only commits that are enough to explain how the files that match the specified paths came to be\&.
190 Paths may need to be prefixed with
191 \fB\-\-\fR
192 to separate them from options or the revision range, when confusion arises\&.
194 .SS "Commit Limiting"
196 Besides specifying a range of commits that should be listed using the special notations explained in the description, additional commit limiting may be applied\&.
198 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\&.
200 Note that these are applied before commit ordering and formatting options, such as \fB\-\-reverse\fR\&.
202 \-<number>, \-n <number>, \-\-max\-count=<number>
203 .RS 4
204 Limit the number of commits to output\&.
207 \-\-skip=<number>
208 .RS 4
209 Skip
210 \fInumber\fR
211 commits before starting to show the commit output\&.
214 \-\-since=<date>, \-\-after=<date>
215 .RS 4
216 Show commits more recent than a specific date\&.
219 \-\-since\-as\-filter=<date>
220 .RS 4
221 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\&.
224 \-\-until=<date>, \-\-before=<date>
225 .RS 4
226 Show commits older than a specific date\&.
229 \-\-author=<pattern>, \-\-committer=<pattern>
230 .RS 4
231 Limit the commits output to ones with author/committer header lines that match the specified pattern (regular expression)\&. With more than one
232 \fB\-\-author=<pattern>\fR, commits whose author matches any of the given patterns are chosen (similarly for multiple
233 \fB\-\-committer=<pattern>\fR)\&.
236 \-\-grep\-reflog=<pattern>
237 .RS 4
238 Limit the commits output to ones with reflog entries that match the specified pattern (regular expression)\&. With more than one
239 \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
240 \fB\-\-walk\-reflogs\fR
241 is in use\&.
244 \-\-grep=<pattern>
245 .RS 4
246 Limit the commits output to ones with log message that matches the specified pattern (regular expression)\&. With more than one
247 \fB\-\-grep=<pattern>\fR, commits whose message matches any of the given patterns are chosen (but see
248 \fB\-\-all\-match\fR)\&.
250 When
251 \fB\-\-notes\fR
252 is in effect, the message from the notes is matched as if it were part of the log message\&.
255 \-\-all\-match
256 .RS 4
257 Limit the commits output to ones that match all given
258 \fB\-\-grep\fR, instead of ones that match at least one\&.
261 \-\-invert\-grep
262 .RS 4
263 Limit the commits output to ones with log message that do not match the pattern specified with
264 \fB\-\-grep=<pattern>\fR\&.
267 \-i, \-\-regexp\-ignore\-case
268 .RS 4
269 Match the regular expression limiting patterns without regard to letter case\&.
272 \-\-basic\-regexp
273 .RS 4
274 Consider the limiting patterns to be basic regular expressions; this is the default\&.
277 \-E, \-\-extended\-regexp
278 .RS 4
279 Consider the limiting patterns to be extended regular expressions instead of the default basic regular expressions\&.
282 \-F, \-\-fixed\-strings
283 .RS 4
284 Consider the limiting patterns to be fixed strings (don\(cqt interpret pattern as a regular expression)\&.
287 \-P, \-\-perl\-regexp
288 .RS 4
289 Consider the limiting patterns to be Perl\-compatible regular expressions\&.
291 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\&.
294 \-\-remove\-empty
295 .RS 4
296 Stop when a given path disappears from the tree\&.
299 \-\-merges
300 .RS 4
301 Print only merge commits\&. This is exactly the same as
302 \fB\-\-min\-parents=2\fR\&.
305 \-\-no\-merges
306 .RS 4
307 Do not print commits with more than one parent\&. This is exactly the same as
308 \fB\-\-max\-parents=1\fR\&.
311 \-\-min\-parents=<number>, \-\-max\-parents=<number>, \-\-no\-min\-parents, \-\-no\-max\-parents
312 .RS 4
313 Show only commits which have at least (or at most) that many parent commits\&. In particular,
314 \fB\-\-max\-parents=1\fR
315 is the same as
316 \fB\-\-no\-merges\fR,
317 \fB\-\-min\-parents=2\fR
318 is the same as
319 \fB\-\-merges\fR\&.
320 \fB\-\-max\-parents=0\fR
321 gives all root commits and
322 \fB\-\-min\-parents=3\fR
323 all octopus merges\&.
325 \fB\-\-no\-min\-parents\fR
327 \fB\-\-no\-max\-parents\fR
328 reset these limits (to no limit) again\&. Equivalent forms are
329 \fB\-\-min\-parents=0\fR
330 (any commit has 0 or more parents) and
331 \fB\-\-max\-parents=\-1\fR
332 (negative numbers denote no upper limit)\&.
335 \-\-first\-parent
336 .RS 4
337 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\&.
340 \-\-exclude\-first\-parent\-only
341 .RS 4
342 When finding commits to exclude (with a
343 \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\&.
346 \-\-not
347 .RS 4
348 Reverses the meaning of the
349 \fI^\fR
350 prefix (or lack thereof) for all following revision specifiers, up to the next
351 \fB\-\-not\fR\&.
354 \-\-all
355 .RS 4
356 Pretend as if all the refs in
357 \fBrefs/\fR, along with
358 \fBHEAD\fR, are listed on the command line as
359 \fI<commit>\fR\&.
362 \-\-branches[=<pattern>]
363 .RS 4
364 Pretend as if all the refs in
365 \fBrefs/heads\fR
366 are listed on the command line as
367 \fI<commit>\fR\&. If
368 \fI<pattern>\fR
369 is given, limit branches to ones matching given shell glob\&. If pattern lacks
370 \fI?\fR,
371 \fI*\fR, or
372 \fI[\fR,
373 \fI/*\fR
374 at the end is implied\&.
377 \-\-tags[=<pattern>]
378 .RS 4
379 Pretend as if all the refs in
380 \fBrefs/tags\fR
381 are listed on the command line as
382 \fI<commit>\fR\&. If
383 \fI<pattern>\fR
384 is given, limit tags to ones matching given shell glob\&. If pattern lacks
385 \fI?\fR,
386 \fI*\fR, or
387 \fI[\fR,
388 \fI/*\fR
389 at the end is implied\&.
392 \-\-remotes[=<pattern>]
393 .RS 4
394 Pretend as if all the refs in
395 \fBrefs/remotes\fR
396 are listed on the command line as
397 \fI<commit>\fR\&. If
398 \fI<pattern>\fR
399 is given, limit remote\-tracking branches to ones matching given shell glob\&. If pattern lacks
400 \fI?\fR,
401 \fI*\fR, or
402 \fI[\fR,
403 \fI/*\fR
404 at the end is implied\&.
407 \-\-glob=<glob\-pattern>
408 .RS 4
409 Pretend as if all the refs matching shell glob
410 \fI<glob\-pattern>\fR
411 are listed on the command line as
412 \fI<commit>\fR\&. Leading
413 \fIrefs/\fR, is automatically prepended if missing\&. If pattern lacks
414 \fI?\fR,
415 \fI*\fR, or
416 \fI[\fR,
417 \fI/*\fR
418 at the end is implied\&.
421 \-\-exclude=<glob\-pattern>
422 .RS 4
423 Do not include refs matching
424 \fI<glob\-pattern>\fR
425 that the next
426 \fB\-\-all\fR,
427 \fB\-\-branches\fR,
428 \fB\-\-tags\fR,
429 \fB\-\-remotes\fR, or
430 \fB\-\-glob\fR
431 would otherwise consider\&. Repetitions of this option accumulate exclusion patterns up to the next
432 \fB\-\-all\fR,
433 \fB\-\-branches\fR,
434 \fB\-\-tags\fR,
435 \fB\-\-remotes\fR, or
436 \fB\-\-glob\fR
437 option (other options or arguments do not clear accumulated patterns)\&.
439 The patterns given should not begin with
440 \fBrefs/heads\fR,
441 \fBrefs/tags\fR, or
442 \fBrefs/remotes\fR
443 when applied to
444 \fB\-\-branches\fR,
445 \fB\-\-tags\fR, or
446 \fB\-\-remotes\fR, respectively, and they must begin with
447 \fBrefs/\fR
448 when applied to
449 \fB\-\-glob\fR
451 \fB\-\-all\fR\&. If a trailing
452 \fI/*\fR
453 is intended, it must be given explicitly\&.
456 \-\-reflog
457 .RS 4
458 Pretend as if all objects mentioned by reflogs are listed on the command line as
459 \fB<commit>\fR\&.
462 \-\-alternate\-refs
463 .RS 4
464 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
465 \fBobjects/info/alternates\fR\&. The set of included objects may be modified by
466 \fBcore\&.alternateRefsCommand\fR, etc\&. See
467 \fBgit-config\fR(1)\&.
470 \-\-single\-worktree
471 .RS 4
472 By default, all working trees will be examined by the following options when there are more than one (see
473 \fBgit-worktree\fR(1)):
474 \fB\-\-all\fR,
475 \fB\-\-reflog\fR
477 \fB\-\-indexed\-objects\fR\&. This option forces them to examine the current working tree only\&.
480 \-\-ignore\-missing
481 .RS 4
482 Upon seeing an invalid object name in the input, pretend as if the bad input was not given\&.
485 \-\-bisect
486 .RS 4
487 Pretend as if the bad bisection ref
488 \fBrefs/bisect/bad\fR
489 was listed and as if it was followed by
490 \fB\-\-not\fR
491 and the good bisection refs
492 \fBrefs/bisect/good\-*\fR
493 on the command line\&.
496 \-\-stdin
497 .RS 4
498 In addition to the
499 \fI<commit>\fR
500 listed on the command line, read them from the standard input\&. If a
501 \fB\-\-\fR
502 separator is seen, stop reading commits and start reading paths to limit the result\&.
505 \-\-cherry\-mark
506 .RS 4
507 Like
508 \fB\-\-cherry\-pick\fR
509 (see below) but mark equivalent commits with
510 \fB=\fR
511 rather than omitting them, and inequivalent ones with
512 \fB+\fR\&.
515 \-\-cherry\-pick
516 .RS 4
517 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\&.
519 For example, if you have two branches,
520 \fBA\fR
522 \fBB\fR, a usual way to list all commits on only one side of them is with
523 \fB\-\-left\-right\fR
524 (see the example below in the description of the
525 \fB\-\-left\-right\fR
526 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\&.
529 \-\-left\-only, \-\-right\-only
530 .RS 4
531 List only commits on the respective side of a symmetric difference, i\&.e\&. only those which would be marked
532 \fB<\fR
533 resp\&.
534 \fB>\fR
536 \fB\-\-left\-right\fR\&.
538 For example,
539 \fB\-\-cherry\-pick \-\-right\-only A\&.\&.\&.B\fR
540 omits those commits from
541 \fBB\fR
542 which are in
543 \fBA\fR
544 or are patch\-equivalent to a commit in
545 \fBA\fR\&. In other words, this lists the
546 \fB+\fR
547 commits from
548 \fBgit cherry A B\fR\&. More precisely,
549 \fB\-\-cherry\-pick \-\-right\-only \-\-no\-merges\fR
550 gives the exact list\&.
553 \-\-cherry
554 .RS 4
555 A synonym for
556 \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
557 \fBgit log \-\-cherry upstream\&.\&.\&.mybranch\fR, similar to
558 \fBgit cherry upstream mybranch\fR\&.
561 \-g, \-\-walk\-reflogs
562 .RS 4
563 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,
564 \fI^commit\fR,
565 \fIcommit1\&.\&.commit2\fR, and
566 \fIcommit1\&.\&.\&.commit2\fR
567 notations cannot be used)\&.
569 With
570 \fB\-\-pretty\fR
571 format other than
572 \fBoneline\fR
574 \fBreference\fR
575 (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
576 \fBref@{Nth}\fR
577 (where
578 \fBNth\fR
579 is the reverse\-chronological index in the reflog) or as
580 \fBref@{timestamp}\fR
581 (with the timestamp for that entry), depending on a few rules:
583 .RS 4
584 .ie n \{\
585 \h'-04' 1.\h'+01'\c
587 .el \{\
588 .sp -1
589 .IP "  1." 4.2
591 If the starting point is specified as
592 \fBref@{Nth}\fR, show the index format\&.
595 .RS 4
596 .ie n \{\
597 \h'-04' 2.\h'+01'\c
599 .el \{\
600 .sp -1
601 .IP "  2." 4.2
603 If the starting point was specified as
604 \fBref@{now}\fR, show the timestamp format\&.
607 .RS 4
608 .ie n \{\
609 \h'-04' 3.\h'+01'\c
611 .el \{\
612 .sp -1
613 .IP "  3." 4.2
615 If neither was used, but
616 \fB\-\-date\fR
617 was given on the command line, show the timestamp in the format requested by
618 \fB\-\-date\fR\&.
621 .RS 4
622 .ie n \{\
623 \h'-04' 4.\h'+01'\c
625 .el \{\
626 .sp -1
627 .IP "  4." 4.2
629 Otherwise, show the index format\&.
632 Under
633 \fB\-\-pretty=oneline\fR, the commit message is prefixed with this information on the same line\&. This option cannot be combined with
634 \fB\-\-reverse\fR\&. See also
635 \fBgit-reflog\fR(1)\&.
637 Under
638 \fB\-\-pretty=reference\fR, this information will not be shown at all\&.
641 \-\-merge
642 .RS 4
643 After a failed merge, show refs that touch files having a conflict and don\(cqt exist on all heads to merge\&.
646 \-\-boundary
647 .RS 4
648 Output excluded boundary commits\&. Boundary commits are prefixed with
649 \fB\-\fR\&.
651 .SS "History Simplification"
653 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\&.
655 The following options select the commits to be shown:
657 <paths>
658 .RS 4
659 Commits modifying the given <paths> are selected\&.
662 \-\-simplify\-by\-decoration
663 .RS 4
664 Commits that are referred by some branch or tag are selected\&.
667 Note that extra commits can be shown to give a meaningful history\&.
669 The following options affect the way the simplification is performed:
671 Default mode
672 .RS 4
673 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)
676 \-\-show\-pulls
677 .RS 4
678 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\&.
681 \-\-full\-history
682 .RS 4
683 Same as the default mode, but does not prune some history\&.
686 \-\-dense
687 .RS 4
688 Only the selected commits are shown, plus some to have a meaningful history\&.
691 \-\-sparse
692 .RS 4
693 All commits in the simplified history are shown\&.
696 \-\-simplify\-merges
697 .RS 4
698 Additional option to
699 \fB\-\-full\-history\fR
700 to remove some needless merges from the resulting history, as there are no selected commits contributing to this merge\&.
703 \-\-ancestry\-path
704 .RS 4
705 When given a range of commits to display (e\&.g\&.
706 \fIcommit1\&.\&.commit2\fR
708 \fIcommit2 ^commit1\fR), only display commits that exist directly on the ancestry chain between the
709 \fIcommit1\fR
711 \fIcommit2\fR, i\&.e\&. commits that are both descendants of
712 \fIcommit1\fR, and ancestors of
713 \fIcommit2\fR\&.
716 A more detailed explanation follows\&.
718 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\&.)
720 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:
722 .if n \{\
723 .RS 4
726           \&.\-A\-\-\-M\-\-\-N\-\-\-O\-\-\-P\-\-\-Q
727          /     /   /   /   /   /
728         I     B   C   D   E   Y
729          \e   /   /   /   /   /
730           `\-\-\-\-\-\-\-\-\-\-\-\-\-\(aq   X
732 .if n \{\
737 The horizontal line of history A\-\-\-Q is taken to be the first parent of each merge\&. The commits are:
739 .RS 4
740 .ie n \{\
741 \h'-04'\(bu\h'+03'\c
743 .el \{\
744 .sp -1
745 .IP \(bu 2.3
747 \fBI\fR
748 is the initial commit, in which
749 \fBfoo\fR
750 exists with contents \(lqasdf\(rq, and a file
751 \fBquux\fR
752 exists with contents \(lqquux\(rq\&. Initial commits are compared to an empty tree, so
753 \fBI\fR
754 is !TREESAME\&.
757 .RS 4
758 .ie n \{\
759 \h'-04'\(bu\h'+03'\c
761 .el \{\
762 .sp -1
763 .IP \(bu 2.3
766 \fBA\fR,
767 \fBfoo\fR
768 contains just \(lqfoo\(rq\&.
771 .RS 4
772 .ie n \{\
773 \h'-04'\(bu\h'+03'\c
775 .el \{\
776 .sp -1
777 .IP \(bu 2.3
779 \fBB\fR
780 contains the same change as
781 \fBA\fR\&. Its merge
782 \fBM\fR
783 is trivial and hence TREESAME to all parents\&.
786 .RS 4
787 .ie n \{\
788 \h'-04'\(bu\h'+03'\c
790 .el \{\
791 .sp -1
792 .IP \(bu 2.3
794 \fBC\fR
795 does not change
796 \fBfoo\fR, but its merge
797 \fBN\fR
798 changes it to \(lqfoobar\(rq, so it is not TREESAME to any parent\&.
801 .RS 4
802 .ie n \{\
803 \h'-04'\(bu\h'+03'\c
805 .el \{\
806 .sp -1
807 .IP \(bu 2.3
809 \fBD\fR
810 sets
811 \fBfoo\fR
812 to \(lqbaz\(rq\&. Its merge
813 \fBO\fR
814 combines the strings from
815 \fBN\fR
817 \fBD\fR
818 to \(lqfoobarbaz\(rq; i\&.e\&., it is not TREESAME to any parent\&.
821 .RS 4
822 .ie n \{\
823 \h'-04'\(bu\h'+03'\c
825 .el \{\
826 .sp -1
827 .IP \(bu 2.3
829 \fBE\fR
830 changes
831 \fBquux\fR
832 to \(lqxyzzy\(rq, and its merge
833 \fBP\fR
834 combines the strings to \(lqquux xyzzy\(rq\&.
835 \fBP\fR
836 is TREESAME to
837 \fBO\fR, but not to
838 \fBE\fR\&.
841 .RS 4
842 .ie n \{\
843 \h'-04'\(bu\h'+03'\c
845 .el \{\
846 .sp -1
847 .IP \(bu 2.3
849 \fBX\fR
850 is an independent root commit that added a new file
851 \fBside\fR, and
852 \fBY\fR
853 modified it\&.
854 \fBY\fR
855 is TREESAME to
856 \fBX\fR\&. Its merge
857 \fBQ\fR
858 added
859 \fBside\fR
861 \fBP\fR, and
862 \fBQ\fR
863 is TREESAME to
864 \fBP\fR, but not to
865 \fBY\fR\&.
868 \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\&.
870 Default mode
871 .RS 4
872 Commits are included if they are not TREESAME to any parent (though this can be changed, see
873 \fB\-\-sparse\fR
874 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\&.
876 This results in:
878 .if n \{\
879 .RS 4
882           \&.\-A\-\-\-N\-\-\-O
883          /     /   /
884         I\-\-\-\-\-\-\-\-\-D
886 .if n \{\
890 Note how the rule to only follow the TREESAME parent, if one is available, removed
891 \fBB\fR
892 from consideration entirely\&.
893 \fBC\fR
894 was considered via
895 \fBN\fR, but is TREESAME\&. Root commits are compared to an empty tree, so
896 \fBI\fR
897 is !TREESAME\&.
899 Parent/child relations are only visible with
900 \fB\-\-parents\fR, but that does not affect the commits selected in default mode, so we have shown the parent lines\&.
903 \-\-full\-history without parent rewriting
904 .RS 4
905 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
907 .if n \{\
908 .RS 4
911         I  A  B  N  D  O  P  Q
913 .if n \{\
917 \fBM\fR
918 was excluded because it is TREESAME to both parents\&.
919 \fBE\fR,
920 \fBC\fR
922 \fBB\fR
923 were all walked, but only
924 \fBB\fR
925 was !TREESAME, so the others do not appear\&.
927 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\&.
930 \-\-full\-history with parent rewriting
931 .RS 4
932 Ordinary commits are only included if they are !TREESAME (though this can be changed, see
933 \fB\-\-sparse\fR
934 below)\&.
936 Merges are always included\&. However, their parent list is rewritten: Along each parent, prune away commits that are not included themselves\&. This results in
938 .if n \{\
939 .RS 4
942           \&.\-A\-\-\-M\-\-\-N\-\-\-O\-\-\-P\-\-\-Q
943          /     /   /   /   /
944         I     B   /   D   /
945          \e   /   /   /   /
946           `\-\-\-\-\-\-\-\-\-\-\-\-\-\(aq
948 .if n \{\
952 Compare to
953 \fB\-\-full\-history\fR
954 without rewriting above\&. Note that
955 \fBE\fR
956 was pruned away because it is TREESAME, but the parent list of P was rewritten to contain
957 \fBE\fR\(aqs parent
958 \fBI\fR\&. The same happened for
959 \fBC\fR
961 \fBN\fR, and
962 \fBX\fR,
963 \fBY\fR
965 \fBQ\fR\&.
968 In addition to the above settings, you can change whether TREESAME affects inclusion:
970 \-\-dense
971 .RS 4
972 Commits that are walked are included if they are not TREESAME to any parent\&.
975 \-\-sparse
976 .RS 4
977 All commits that are walked are included\&.
979 Note that without
980 \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\&.
983 \-\-simplify\-merges
984 .RS 4
985 First, build a history graph in the same way that
986 \fB\-\-full\-history\fR
987 with parent rewriting does (see above)\&.
989 Then simplify each commit
990 \fBC\fR
991 to its replacement
992 \fBC\(aq\fR
993 in the final history according to the following rules:
995 .RS 4
996 .ie n \{\
997 \h'-04'\(bu\h'+03'\c
999 .el \{\
1000 .sp -1
1001 .IP \(bu 2.3
1004 \fBC\(aq\fR
1006 \fBC\fR\&.
1009 .RS 4
1010 .ie n \{\
1011 \h'-04'\(bu\h'+03'\c
1013 .el \{\
1014 .sp -1
1015 .IP \(bu 2.3
1017 Replace each parent
1018 \fBP\fR
1020 \fBC\(aq\fR
1021 with its simplification
1022 \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\&.
1025 .RS 4
1026 .ie n \{\
1027 \h'-04'\(bu\h'+03'\c
1029 .el \{\
1030 .sp -1
1031 .IP \(bu 2.3
1033 If after this parent rewriting,
1034 \fBC\(aq\fR
1035 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\&.
1038 The effect of this is best shown by way of comparing to
1039 \fB\-\-full\-history\fR
1040 with parent rewriting\&. The example turns into:
1042 .if n \{\
1043 .RS 4
1046           \&.\-A\-\-\-M\-\-\-N\-\-\-O
1047          /     /       /
1048         I     B       D
1049          \e   /       /
1050           `\-\-\-\-\-\-\-\-\-\(aq
1052 .if n \{\
1056 Note the major differences in
1057 \fBN\fR,
1058 \fBP\fR, and
1059 \fBQ\fR
1060 over
1061 \fB\-\-full\-history\fR:
1063 .RS 4
1064 .ie n \{\
1065 \h'-04'\(bu\h'+03'\c
1067 .el \{\
1068 .sp -1
1069 .IP \(bu 2.3
1071 \fBN\fR\(aqs parent list had
1072 \fBI\fR
1073 removed, because it is an ancestor of the other parent
1074 \fBM\fR\&. Still,
1075 \fBN\fR
1076 remained because it is !TREESAME\&.
1079 .RS 4
1080 .ie n \{\
1081 \h'-04'\(bu\h'+03'\c
1083 .el \{\
1084 .sp -1
1085 .IP \(bu 2.3
1087 \fBP\fR\(aqs parent list similarly had
1088 \fBI\fR
1089 removed\&.
1090 \fBP\fR
1091 was then removed completely, because it had one parent and is TREESAME\&.
1094 .RS 4
1095 .ie n \{\
1096 \h'-04'\(bu\h'+03'\c
1098 .el \{\
1099 .sp -1
1100 .IP \(bu 2.3
1102 \fBQ\fR\(aqs parent list had
1103 \fBY\fR
1104 simplified to
1105 \fBX\fR\&.
1106 \fBX\fR
1107 was then removed, because it was a TREESAME root\&.
1108 \fBQ\fR
1109 was then removed completely, because it had one parent and is TREESAME\&.
1113 There is another simplification mode available:
1115 \-\-ancestry\-path
1116 .RS 4
1117 Limit the displayed commits to those directly on the ancestry chain between the \(lqfrom\(rq and \(lqto\(rq commits in the given commit range\&. I\&.e\&. only display commits that are ancestor of the \(lqto\(rq commit and descendants of the \(lqfrom\(rq commit\&.
1119 As an example use case, consider the following commit history:
1121 .if n \{\
1122 .RS 4
1125             D\-\-\-E\-\-\-\-\-\-\-F
1126            /     \e       \e
1127           B\-\-\-C\-\-\-G\-\-\-H\-\-\-I\-\-\-J
1128          /                     \e
1129         A\-\-\-\-\-\-\-K\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-L\-\-M
1131 .if n \{\
1135 A regular
1136 \fID\&.\&.M\fR
1137 computes the set of commits that are ancestors of
1138 \fBM\fR, but excludes the ones that are ancestors of
1139 \fBD\fR\&. This is useful to see what happened to the history leading to
1140 \fBM\fR
1141 since
1142 \fBD\fR, in the sense that \(lqwhat does
1143 \fBM\fR
1144 have that did not exist in
1145 \fBD\fR\(rq\&. The result in this example would be all the commits, except
1146 \fBA\fR
1148 \fBB\fR
1149 (and
1150 \fBD\fR
1151 itself, of course)\&.
1153 When we want to find out what commits in
1154 \fBM\fR
1155 are contaminated with the bug introduced by
1156 \fBD\fR
1157 and need fixing, however, we might want to view only the subset of
1158 \fID\&.\&.M\fR
1159 that are actually descendants of
1160 \fBD\fR, i\&.e\&. excluding
1161 \fBC\fR
1163 \fBK\fR\&. This is exactly what the
1164 \fB\-\-ancestry\-path\fR
1165 option does\&. Applied to the
1166 \fID\&.\&.M\fR
1167 range, it results in:
1169 .if n \{\
1170 .RS 4
1173                 E\-\-\-\-\-\-\-F
1174                  \e       \e
1175                   G\-\-\-H\-\-\-I\-\-\-J
1176                                \e
1177                                 L\-\-M
1179 .if n \{\
1185 Before discussing another option, \fB\-\-show\-pulls\fR, we need to create a new example history\&.
1187 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:
1189 .if n \{\
1190 .RS 4
1193           \&.\-A\-\-\-M\-\-\-\-\-C\-\-N\-\-\-O\-\-\-P
1194          /     / \e  \e  \e/   /   /
1195         I     B   \e  R\-\(aq`\-Z\(aq   /
1196          \e   /     \e/         /
1197           \e /      /\e        /
1198            `\-\-\-X\-\-\(aq  `\-\-\-Y\-\-\(aq
1200 .if n \{\
1205 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\&.
1207 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:
1209 .if n \{\
1210 .RS 4
1213         I\-\-\-X
1215 .if n \{\
1220 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:
1222 .if n \{\
1223 .RS 4
1226           \&.\-A\-\-\-M\-\-\-\-\-\-\-\-N\-\-\-O\-\-\-P
1227          /     / \e  \e  \e/   /   /
1228         I     B   \e  R\-\(aq`\-\-\(aq   /
1229          \e   /     \e/         /
1230           \e /      /\e        /
1231            `\-\-\-X\-\-\(aq  `\-\-\-\-\-\-\(aq
1233 .if n \{\
1238 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: manu unrelated merges appear in the \fB\-\-full\-history\fR results\&.
1240 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:
1242 .if n \{\
1243 .RS 4
1246           \&.\-A\-\-\-M\-\-\&.
1247          /     /    \e
1248         I     B      R
1249          \e   /      /
1250           \e /      /
1251            `\-\-\-X\-\-\(aq
1253 .if n \{\
1258 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\&.
1260 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\&.
1262 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\&.
1264 \-\-show\-pulls
1265 .RS 4
1266 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\&.
1268 When a merge commit is included by
1269 \fB\-\-show\-pulls\fR, the merge is treated as if it "pulled" the change from another branch\&. When using
1270 \fB\-\-show\-pulls\fR
1271 on this example (and no other options) the resulting graph is:
1273 .if n \{\
1274 .RS 4
1277         I\-\-\-X\-\-\-R\-\-\-N
1279 .if n \{\
1283 Here, the merge commits
1284 \fBR\fR
1286 \fBN\fR
1287 are included because they pulled the commits
1288 \fBX\fR
1290 \fBR\fR
1291 into the base branch, respectively\&. These merges are the reason the commits
1292 \fBA\fR
1294 \fBB\fR
1295 do not appear in the default history\&.
1297 When
1298 \fB\-\-show\-pulls\fR
1299 is paired with
1300 \fB\-\-simplify\-merges\fR, the graph includes all of the necessary information:
1302 .if n \{\
1303 .RS 4
1306           \&.\-A\-\-\-M\-\-\&.   N
1307          /     /    \e /
1308         I     B      R
1309          \e   /      /
1310           \e /      /
1311            `\-\-\-X\-\-\(aq
1313 .if n \{\
1317 Notice that since
1318 \fBM\fR
1319 is reachable from
1320 \fBR\fR, the edge from
1321 \fBN\fR
1323 \fBM\fR
1324 was simplified away\&. However,
1325 \fBN\fR
1326 still appears in the history as an important commit because it "pulled" the change
1327 \fBR\fR
1328 into the main branch\&.
1331 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)\&.
1332 .SH "MAPPING AUTHORS"
1334 See \fBgitmailmap\fR(5)\&.
1336 Note that if \fBgit shortlog\fR is run outside of a repository (to process log contents on standard input), it will look for a \fB\&.mailmap\fR file in the current directory\&.
1337 .SH "GIT"
1339 Part of the \fBgit\fR(1) suite