]>
Commit | Line | Data |
---|---|---|
fdcf39e5 MV |
1 | Commit Limiting |
2 | ~~~~~~~~~~~~~~~ | |
3 | ||
4 | Besides specifying a range of commits that should be listed using the | |
5 | special notations explained in the description, additional commit | |
a23e3138 JH |
6 | limiting may be applied. |
7 | ||
8 | Using more options generally further limits the output (e.g. | |
9 | `--since=<date1>` limits to commits newer than `<date1>`, and using it | |
10 | with `--grep=<pattern>` further limits to commits whose log message | |
11 | has a line that matches `<pattern>`), unless otherwise noted. | |
12 | ||
13 | Note that these are applied before commit | |
14 | ordering and formatting options, such as `--reverse`. | |
fdcf39e5 | 15 | |
70c2a258 NTND |
16 | -<number>:: |
17 | -n <number>:: | |
982962ce | 18 | --max-count=<number>:: |
841d8118 | 19 | Limit the number of commits to output. |
fdcf39e5 | 20 | |
982962ce | 21 | --skip=<number>:: |
fdcf39e5 MV |
22 | Skip 'number' commits before starting to show the commit output. |
23 | ||
982962ce MM |
24 | --since=<date>:: |
25 | --after=<date>:: | |
fdcf39e5 MV |
26 | Show commits more recent than a specific date. |
27 | ||
982962ce MM |
28 | --until=<date>:: |
29 | --before=<date>:: | |
fdcf39e5 MV |
30 | Show commits older than a specific date. |
31 | ||
56b6d01d | 32 | ifdef::git-rev-list[] |
982962ce MM |
33 | --max-age=<timestamp>:: |
34 | --min-age=<timestamp>:: | |
fdcf39e5 | 35 | Limit the commits output to specified time range. |
56b6d01d | 36 | endif::git-rev-list[] |
fdcf39e5 | 37 | |
982962ce MM |
38 | --author=<pattern>:: |
39 | --committer=<pattern>:: | |
fdcf39e5 | 40 | Limit the commits output to ones with author/committer |
a23e3138 JH |
41 | header lines that match the specified pattern (regular |
42 | expression). With more than one `--author=<pattern>`, | |
43 | commits whose author matches any of the given patterns are | |
44 | chosen (similarly for multiple `--committer=<pattern>`). | |
fdcf39e5 | 45 | |
72fd13f7 | 46 | --grep-reflog=<pattern>:: |
72fd13f7 NTND |
47 | Limit the commits output to ones with reflog entries that |
48 | match the specified pattern (regular expression). With | |
49 | more than one `--grep-reflog`, commits whose reflog message | |
baa6378f JH |
50 | matches any of the given patterns are chosen. It is an |
51 | error to use this option unless `--walk-reflogs` is in use. | |
72fd13f7 | 52 | |
982962ce | 53 | --grep=<pattern>:: |
fdcf39e5 | 54 | Limit the commits output to ones with log message that |
a23e3138 JH |
55 | matches the specified pattern (regular expression). With |
56 | more than one `--grep=<pattern>`, commits whose message | |
57 | matches any of the given patterns are chosen (but see | |
58 | `--all-match`). | |
2aea7a51 | 59 | ifndef::git-rev-list[] |
38cfe915 | 60 | + |
9d45ac4c | 61 | When `--notes` is in effect, the message from the notes is |
7348cdeb | 62 | matched as if it were part of the log message. |
2aea7a51 | 63 | endif::git-rev-list[] |
fdcf39e5 | 64 | |
7756ba74 | 65 | --all-match:: |
4528aa1a | 66 | Limit the commits output to ones that match all given `--grep`, |
a23e3138 | 67 | instead of ones that match at least one. |
7756ba74 | 68 | |
22dfa8a2 CJ |
69 | --invert-grep:: |
70 | Limit the commits output to ones with log message that do not | |
71 | match the pattern specified with `--grep=<pattern>`. | |
72 | ||
3240240f SB |
73 | -i:: |
74 | --regexp-ignore-case:: | |
19d6eb41 JSJ |
75 | Match the regular expression limiting patterns without regard to letter |
76 | case. | |
fdcf39e5 | 77 | |
727b6fc3 | 78 | --basic-regexp:: |
727b6fc3 JH |
79 | Consider the limiting patterns to be basic regular expressions; |
80 | this is the default. | |
81 | ||
3240240f SB |
82 | -E:: |
83 | --extended-regexp:: | |
fdcf39e5 MV |
84 | Consider the limiting patterns to be extended regular expressions |
85 | instead of the default basic regular expressions. | |
86 | ||
3240240f SB |
87 | -F:: |
88 | --fixed-strings:: | |
dc1c0fff JN |
89 | Consider the limiting patterns to be fixed strings (don't interpret |
90 | pattern as a regular expression). | |
91 | ||
7531a2dd | 92 | -P:: |
727b6fc3 | 93 | --perl-regexp:: |
d048cb13 ÆAB |
94 | Consider the limiting patterns to be Perl-compatible regular |
95 | expressions. | |
96 | + | |
97 | Support for these types of regular expressions is an optional | |
98 | compile-time dependency. If Git wasn't compiled with support for them | |
99 | providing this option will cause it to die. | |
727b6fc3 | 100 | |
fdcf39e5 | 101 | --remove-empty:: |
fdcf39e5 MV |
102 | Stop when a given path disappears from the tree. |
103 | ||
2657420d | 104 | --merges:: |
6a6ebded | 105 | Print only merge commits. This is exactly the same as `--min-parents=2`. |
2657420d | 106 | |
fdcf39e5 | 107 | --no-merges:: |
6a6ebded MG |
108 | Do not print commits with more than one parent. This is |
109 | exactly the same as `--max-parents=1`. | |
110 | ||
111 | --min-parents=<number>:: | |
112 | --max-parents=<number>:: | |
113 | --no-min-parents:: | |
114 | --no-max-parents:: | |
5104d21f | 115 | Show only commits which have at least (or at most) that many parent |
6a6ebded MG |
116 | commits. In particular, `--max-parents=1` is the same as `--no-merges`, |
117 | `--min-parents=2` is the same as `--merges`. `--max-parents=0` | |
118 | gives all root commits and `--min-parents=3` all octopus merges. | |
119 | + | |
120 | `--no-min-parents` and `--no-max-parents` reset these limits (to no limit) | |
121 | again. Equivalent forms are `--min-parents=0` (any commit has 0 or more | |
122 | parents) and `--max-parents=-1` (negative numbers denote no upper limit). | |
fdcf39e5 MV |
123 | |
124 | --first-parent:: | |
125 | Follow only the first parent commit upon seeing a merge | |
126 | commit. This option can give a better overview when | |
127 | viewing the evolution of a particular topic branch, | |
128 | because merges into a topic branch tend to be only about | |
129 | adjusting to updated upstream from time to time, and | |
130 | this option allows you to ignore the individual commits | |
f88851c6 KD |
131 | brought in to your history by such a merge. Cannot be |
132 | combined with --bisect. | |
fdcf39e5 MV |
133 | |
134 | --not:: | |
fdcf39e5 | 135 | Reverses the meaning of the '{caret}' prefix (or lack thereof) |
4528aa1a | 136 | for all following revision specifiers, up to the next `--not`. |
fdcf39e5 MV |
137 | |
138 | --all:: | |
209df269 NTND |
139 | Pretend as if all the refs in `refs/`, along with `HEAD`, are |
140 | listed on the command line as '<commit>'. | |
c2e6385d | 141 | |
62b4698e | 142 | --branches[=<pattern>]:: |
cc1b8d8b | 143 | Pretend as if all the refs in `refs/heads` are listed |
62b4698e | 144 | on the command line as '<commit>'. If '<pattern>' is given, limit |
b09fe971 | 145 | branches to ones matching given shell glob. If pattern lacks '?', |
e34bb2e7 | 146 | '{asterisk}', or '[', '/{asterisk}' at the end is implied. |
c2e6385d | 147 | |
62b4698e | 148 | --tags[=<pattern>]:: |
cc1b8d8b | 149 | Pretend as if all the refs in `refs/tags` are listed |
62b4698e | 150 | on the command line as '<commit>'. If '<pattern>' is given, limit |
e34bb2e7 CMN |
151 | tags to ones matching given shell glob. If pattern lacks '?', '{asterisk}', |
152 | or '[', '/{asterisk}' at the end is implied. | |
c2e6385d | 153 | |
62b4698e | 154 | --remotes[=<pattern>]:: |
cc1b8d8b | 155 | Pretend as if all the refs in `refs/remotes` are listed |
62b4698e | 156 | on the command line as '<commit>'. If '<pattern>' is given, limit |
0e615b25 | 157 | remote-tracking branches to ones matching given shell glob. |
e34bb2e7 | 158 | If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied. |
fdcf39e5 | 159 | |
62b4698e ŠN |
160 | --glob=<glob-pattern>:: |
161 | Pretend as if all the refs matching shell glob '<glob-pattern>' | |
d08bae7e | 162 | are listed on the command line as '<commit>'. Leading 'refs/', |
e34bb2e7 CMN |
163 | is automatically prepended if missing. If pattern lacks '?', '{asterisk}', |
164 | or '[', '/{asterisk}' at the end is implied. | |
d08bae7e | 165 | |
574d370b JS |
166 | --exclude=<glob-pattern>:: |
167 | ||
168 | Do not include refs matching '<glob-pattern>' that the next `--all`, | |
169 | `--branches`, `--tags`, `--remotes`, or `--glob` would otherwise | |
170 | consider. Repetitions of this option accumulate exclusion patterns | |
171 | up to the next `--all`, `--branches`, `--tags`, `--remotes`, or | |
172 | `--glob` option (other options or arguments do not clear | |
f745acb0 | 173 | accumulated patterns). |
574d370b JS |
174 | + |
175 | The patterns given should not begin with `refs/heads`, `refs/tags`, or | |
176 | `refs/remotes` when applied to `--branches`, `--tags`, or `--remotes`, | |
177 | respectively, and they must begin with `refs/` when applied to `--glob` | |
178 | or `--all`. If a trailing '/{asterisk}' is intended, it must be given | |
179 | explicitly. | |
180 | ||
41d018d1 JK |
181 | --reflog:: |
182 | Pretend as if all objects mentioned by reflogs are listed on the | |
183 | command line as `<commit>`. | |
184 | ||
39b44ba7 JK |
185 | --alternate-refs:: |
186 | Pretend as if all objects mentioned as ref tips of alternate | |
187 | repositories were listed on the command line. An alternate | |
188 | repository is any repository whose object directory is specified | |
189 | in `objects/info/alternates`. The set of included objects may | |
190 | be modified by `core.alternateRefsCommand`, etc. See | |
191 | linkgit:git-config[1]. | |
192 | ||
32619f99 NTND |
193 | --single-worktree:: |
194 | By default, all working trees will be examined by the | |
195 | following options when there are more than one (see | |
196 | linkgit:git-worktree[1]): `--all`, `--reflog` and | |
197 | `--indexed-objects`. | |
198 | This option forces them to examine the current working tree | |
199 | only. | |
200 | ||
cc243c3c | 201 | --ignore-missing:: |
cc243c3c JH |
202 | Upon seeing an invalid object name in the input, pretend as if |
203 | the bad input was not given. | |
d08bae7e | 204 | |
af06e93a CC |
205 | ifndef::git-rev-list[] |
206 | --bisect:: | |
cc1b8d8b | 207 | Pretend as if the bad bisection ref `refs/bisect/bad` |
af06e93a | 208 | was listed and as if it was followed by `--not` and the good |
cc1b8d8b | 209 | bisection refs `refs/bisect/good-*` on the command |
f88851c6 | 210 | line. Cannot be combined with --first-parent. |
af06e93a CC |
211 | endif::git-rev-list[] |
212 | ||
fdcf39e5 | 213 | --stdin:: |
fdcf39e5 | 214 | In addition to the '<commit>' listed on the command |
04b125de | 215 | line, read them from the standard input. If a `--` separator is |
60da8b15 JH |
216 | seen, stop reading commits and start reading paths to limit the |
217 | result. | |
fdcf39e5 | 218 | |
8b3dce56 | 219 | ifdef::git-rev-list[] |
fdcf39e5 | 220 | --quiet:: |
fdcf39e5 MV |
221 | Don't print anything to standard output. This form |
222 | is primarily meant to allow the caller to | |
223 | test the exit status to see if a range of objects is fully | |
224 | connected (or not). It is faster than redirecting stdout | |
4528aa1a | 225 | to `/dev/null` as the output does not have to be formatted. |
adf60f14 | 226 | endif::git-rev-list[] |
fdcf39e5 | 227 | |
cb56e309 | 228 | --cherry-mark:: |
cb56e309 MG |
229 | Like `--cherry-pick` (see below) but mark equivalent commits |
230 | with `=` rather than omitting them, and inequivalent ones with `+`. | |
231 | ||
fdcf39e5 | 232 | --cherry-pick:: |
fdcf39e5 | 233 | Omit any commit that introduces the same change as |
4528aa1a | 234 | another commit on the ``other side'' when the set of |
fdcf39e5 MV |
235 | commits are limited with symmetric difference. |
236 | + | |
237 | For example, if you have two branches, `A` and `B`, a usual way | |
238 | to list all commits on only one side of them is with | |
3add01bb | 239 | `--left-right` (see the example below in the description of |
19d6eb41 JSJ |
240 | the `--left-right` option). However, it shows the commits that were |
241 | cherry-picked from the other branch (for example, ``3rd on b'' may be | |
242 | cherry-picked from branch A). With this option, such pairs of commits are | |
fdcf39e5 MV |
243 | excluded from the output. |
244 | ||
59c8afdf MG |
245 | --left-only:: |
246 | --right-only:: | |
27ac8371 | 247 | List only commits on the respective side of a symmetric difference, |
59c8afdf MG |
248 | i.e. only those which would be marked `<` resp. `>` by |
249 | `--left-right`. | |
250 | + | |
251 | For example, `--cherry-pick --right-only A...B` omits those | |
252 | commits from `B` which are in `A` or are patch-equivalent to a commit in | |
6cf378f0 | 253 | `A`. In other words, this lists the `+` commits from `git cherry A B`. |
59c8afdf MG |
254 | More precisely, `--cherry-pick --right-only --no-merges` gives the exact |
255 | list. | |
256 | ||
94f605ec | 257 | --cherry:: |
94f605ec MG |
258 | A synonym for `--right-only --cherry-mark --no-merges`; useful to |
259 | limit the output to the commits on our side and mark those that | |
260 | have been applied to the other side of a forked history with | |
261 | `git log --cherry upstream...mybranch`, similar to | |
262 | `git cherry upstream mybranch`. | |
263 | ||
3240240f SB |
264 | -g:: |
265 | --walk-reflogs:: | |
fdcf39e5 MV |
266 | Instead of walking the commit ancestry chain, walk |
267 | reflog entries from the most recent one to older ones. | |
268 | When this option is used you cannot specify commits to | |
269 | exclude (that is, '{caret}commit', 'commit1..commit2', | |
a58088ab | 270 | and 'commit1\...commit2' notations cannot be used). |
fdcf39e5 | 271 | + |
1f0fc1db | 272 | With `--pretty` format other than `oneline` and `reference` (for obvious reasons), |
fdcf39e5 | 273 | this causes the output to have two extra lines of information |
83c9f95c JK |
274 | taken from the reflog. The reflog designator in the output may be shown |
275 | as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the | |
276 | reflog) or as `ref@{timestamp}` (with the timestamp for that entry), | |
277 | depending on a few rules: | |
278 | + | |
279 | -- | |
280 | 1. If the starting point is specified as `ref@{Nth}`, show the index | |
ba170517 | 281 | format. |
83c9f95c JK |
282 | + |
283 | 2. If the starting point was specified as `ref@{now}`, show the | |
ba170517 | 284 | timestamp format. |
83c9f95c JK |
285 | + |
286 | 3. If neither was used, but `--date` was given on the command line, show | |
ba170517 | 287 | the timestamp in the format requested by `--date`. |
83c9f95c JK |
288 | + |
289 | 4. Otherwise, show the index format. | |
290 | -- | |
291 | + | |
292 | Under `--pretty=oneline`, the commit message is | |
fdcf39e5 | 293 | prefixed with this information on the same line. |
4528aa1a | 294 | This option cannot be combined with `--reverse`. |
fdcf39e5 | 295 | See also linkgit:git-reflog[1]. |
1f0fc1db DL |
296 | + |
297 | Under `--pretty=reference`, this information will not be shown at all. | |
fdcf39e5 MV |
298 | |
299 | --merge:: | |
fdcf39e5 MV |
300 | After a failed merge, show refs that touch files having a |
301 | conflict and don't exist on all heads to merge. | |
302 | ||
303 | --boundary:: | |
e32db66d KB |
304 | Output excluded boundary commits. Boundary commits are |
305 | prefixed with `-`. | |
fdcf39e5 | 306 | |
aa32939f VM |
307 | ifdef::git-rev-list[] |
308 | --use-bitmap-index:: | |
309 | ||
310 | Try to speed up the traversal using the pack bitmap index (if | |
311 | one is available). Note that when traversing with `--objects`, | |
312 | trees and blobs will not have their associated path printed. | |
434ea3cd JK |
313 | |
314 | --progress=<header>:: | |
315 | Show progress reports on stderr as objects are considered. The | |
316 | `<header>` text will be printed with each progress update. | |
aa32939f VM |
317 | endif::git-rev-list[] |
318 | ||
70d9895e TR |
319 | History Simplification |
320 | ~~~~~~~~~~~~~~~~~~~~~~ | |
321 | ||
7bc2508b SB |
322 | Sometimes you are only interested in parts of the history, for example the |
323 | commits modifying a particular <path>. But there are two parts of | |
324 | 'History Simplification', one part is selecting the commits and the other | |
325 | is how to do it, as there are various strategies to simplify the history. | |
326 | ||
327 | The following options select the commits to be shown: | |
328 | ||
329 | <paths>:: | |
7bc2508b SB |
330 | Commits modifying the given <paths> are selected. |
331 | ||
332 | --simplify-by-decoration:: | |
7bc2508b SB |
333 | Commits that are referred by some branch or tag are selected. |
334 | ||
335 | Note that extra commits can be shown to give a meaningful history. | |
336 | ||
337 | The following options affect the way the simplification is performed: | |
338 | ||
339 | Default mode:: | |
7bc2508b SB |
340 | Simplifies the history to the simplest history explaining the |
341 | final state of the tree. Simplest because it prunes some side | |
342 | branches if the end result is the same (i.e. merging branches | |
343 | with the same content) | |
344 | ||
8d049e18 DS |
345 | --show-pulls:: |
346 | Include all commits from the default mode, but also any merge | |
347 | commits that are not TREESAME to the first parent but are | |
348 | TREESAME to a later parent. This mode is helpful for showing | |
349 | the merge commits that "first introduced" a change to a branch. | |
350 | ||
7bc2508b | 351 | --full-history:: |
df6b0cad | 352 | Same as the default mode, but does not prune some history. |
7bc2508b SB |
353 | |
354 | --dense:: | |
7bc2508b SB |
355 | Only the selected commits are shown, plus some to have a |
356 | meaningful history. | |
357 | ||
358 | --sparse:: | |
7bc2508b SB |
359 | All commits in the simplified history are shown. |
360 | ||
361 | --simplify-merges:: | |
4528aa1a | 362 | Additional option to `--full-history` to remove some needless |
7bc2508b SB |
363 | merges from the resulting history, as there are no selected |
364 | commits contributing to this merge. | |
365 | ||
57456ef4 | 366 | --ancestry-path:: |
57456ef4 JH |
367 | When given a range of commits to display (e.g. 'commit1..commit2' |
368 | or 'commit2 {caret}commit1'), only display commits that exist | |
369 | directly on the ancestry chain between the 'commit1' and | |
370 | 'commit2', i.e. commits that are both descendants of 'commit1', | |
371 | and ancestors of 'commit2'. | |
372 | ||
7bc2508b | 373 | A more detailed explanation follows. |
70d9895e TR |
374 | |
375 | Suppose you specified `foo` as the <paths>. We shall call commits | |
376 | that modify `foo` !TREESAME, and the rest TREESAME. (In a diff | |
377 | filtered for `foo`, they look different and equal, respectively.) | |
378 | ||
379 | In the following, we will always refer to the same example history to | |
380 | illustrate the differences between simplification settings. We assume | |
381 | that you are filtering for a file `foo` in this commit graph: | |
382 | ----------------------------------------------------------------------- | |
143f1eaf KB |
383 | .-A---M---N---O---P---Q |
384 | / / / / / / | |
385 | I B C D E Y | |
386 | \ / / / / / | |
387 | `-------------' X | |
70d9895e | 388 | ----------------------------------------------------------------------- |
143f1eaf | 389 | The horizontal line of history A---Q is taken to be the first parent of |
70d9895e TR |
390 | each merge. The commits are: |
391 | ||
392 | * `I` is the initial commit, in which `foo` exists with contents | |
4528aa1a | 393 | ``asdf'', and a file `quux` exists with contents ``quux''. Initial |
70d9895e TR |
394 | commits are compared to an empty tree, so `I` is !TREESAME. |
395 | ||
4528aa1a | 396 | * In `A`, `foo` contains just ``foo''. |
70d9895e TR |
397 | |
398 | * `B` contains the same change as `A`. Its merge `M` is trivial and | |
399 | hence TREESAME to all parents. | |
400 | ||
4528aa1a | 401 | * `C` does not change `foo`, but its merge `N` changes it to ``foobar'', |
70d9895e TR |
402 | so it is not TREESAME to any parent. |
403 | ||
4528aa1a JSJ |
404 | * `D` sets `foo` to ``baz''. Its merge `O` combines the strings from |
405 | `N` and `D` to ``foobarbaz''; i.e., it is not TREESAME to any parent. | |
70d9895e | 406 | |
4528aa1a JSJ |
407 | * `E` changes `quux` to ``xyzzy'', and its merge `P` combines the |
408 | strings to ``quux xyzzy''. `P` is TREESAME to `O`, but not to `E`. | |
70d9895e | 409 | |
17b83d71 | 410 | * `X` is an independent root commit that added a new file `side`, and `Y` |
143f1eaf KB |
411 | modified it. `Y` is TREESAME to `X`. Its merge `Q` added `side` to `P`, and |
412 | `Q` is TREESAME to `P`, but not to `Y`. | |
413 | ||
4528aa1a JSJ |
414 | `rev-list` walks backwards through history, including or excluding |
415 | commits based on whether `--full-history` and/or parent rewriting | |
416 | (via `--parents` or `--children`) are used. The following settings | |
70d9895e TR |
417 | are available. |
418 | ||
419 | Default mode:: | |
70d9895e | 420 | Commits are included if they are not TREESAME to any parent |
4528aa1a | 421 | (though this can be changed, see `--sparse` below). If the |
70d9895e TR |
422 | commit was a merge, and it was TREESAME to one parent, follow |
423 | only that parent. (Even if there are several TREESAME | |
424 | parents, follow only one of them.) Otherwise, follow all | |
425 | parents. | |
426 | + | |
427 | This results in: | |
428 | + | |
429 | ----------------------------------------------------------------------- | |
430 | .-A---N---O | |
f70d0586 | 431 | / / / |
70d9895e TR |
432 | I---------D |
433 | ----------------------------------------------------------------------- | |
434 | + | |
435 | Note how the rule to only follow the TREESAME parent, if one is | |
436 | available, removed `B` from consideration entirely. `C` was | |
437 | considered via `N`, but is TREESAME. Root commits are compared to an | |
438 | empty tree, so `I` is !TREESAME. | |
439 | + | |
4528aa1a | 440 | Parent/child relations are only visible with `--parents`, but that does |
70d9895e TR |
441 | not affect the commits selected in default mode, so we have shown the |
442 | parent lines. | |
443 | ||
444 | --full-history without parent rewriting:: | |
70d9895e TR |
445 | This mode differs from the default in one point: always follow |
446 | all parents of a merge, even if it is TREESAME to one of them. | |
447 | Even if more than one side of the merge has commits that are | |
448 | included, this does not imply that the merge itself is! In | |
449 | the example, we get | |
450 | + | |
451 | ----------------------------------------------------------------------- | |
143f1eaf | 452 | I A B N D O P Q |
70d9895e TR |
453 | ----------------------------------------------------------------------- |
454 | + | |
d0af663e | 455 | `M` was excluded because it is TREESAME to both parents. `E`, |
70d9895e TR |
456 | `C` and `B` were all walked, but only `B` was !TREESAME, so the others |
457 | do not appear. | |
458 | + | |
459 | Note that without parent rewriting, it is not really possible to talk | |
460 | about the parent/child relationships between the commits, so we show | |
461 | them disconnected. | |
462 | ||
463 | --full-history with parent rewriting:: | |
70d9895e | 464 | Ordinary commits are only included if they are !TREESAME |
4528aa1a | 465 | (though this can be changed, see `--sparse` below). |
70d9895e TR |
466 | + |
467 | Merges are always included. However, their parent list is rewritten: | |
468 | Along each parent, prune away commits that are not included | |
469 | themselves. This results in | |
470 | + | |
471 | ----------------------------------------------------------------------- | |
143f1eaf | 472 | .-A---M---N---O---P---Q |
70d9895e TR |
473 | / / / / / |
474 | I B / D / | |
475 | \ / / / / | |
476 | `-------------' | |
477 | ----------------------------------------------------------------------- | |
478 | + | |
4528aa1a | 479 | Compare to `--full-history` without rewriting above. Note that `E` |
70d9895e TR |
480 | was pruned away because it is TREESAME, but the parent list of P was |
481 | rewritten to contain `E`'s parent `I`. The same happened for `C` and | |
143f1eaf | 482 | `N`, and `X`, `Y` and `Q`. |
70d9895e TR |
483 | |
484 | In addition to the above settings, you can change whether TREESAME | |
485 | affects inclusion: | |
486 | ||
3240240f | 487 | --dense:: |
70d9895e TR |
488 | Commits that are walked are included if they are not TREESAME |
489 | to any parent. | |
490 | ||
3240240f | 491 | --sparse:: |
70d9895e TR |
492 | All commits that are walked are included. |
493 | + | |
4528aa1a | 494 | Note that without `--full-history`, this still simplifies merges: if |
70d9895e TR |
495 | one of the parents is TREESAME, we follow only that one, so the other |
496 | sides of the merge are never walked. | |
fdcf39e5 | 497 | |
d266a988 | 498 | --simplify-merges:: |
d266a988 | 499 | First, build a history graph in the same way that |
4528aa1a | 500 | `--full-history` with parent rewriting does (see above). |
d266a988 TR |
501 | + |
502 | Then simplify each commit `C` to its replacement `C'` in the final | |
503 | history according to the following rules: | |
504 | + | |
505 | -- | |
506 | * Set `C'` to `C`. | |
507 | + | |
508 | * Replace each parent `P` of `C'` with its simplification `P'`. In | |
143f1eaf KB |
509 | the process, drop parents that are ancestors of other parents or that are |
510 | root commits TREESAME to an empty tree, and remove duplicates, but take care | |
511 | to never drop all parents that we are TREESAME to. | |
d266a988 TR |
512 | + |
513 | * If after this parent rewriting, `C'` is a root or merge commit (has | |
514 | zero or >1 parents), a boundary commit, or !TREESAME, it remains. | |
515 | Otherwise, it is replaced with its only parent. | |
516 | -- | |
517 | + | |
518 | The effect of this is best shown by way of comparing to | |
4528aa1a | 519 | `--full-history` with parent rewriting. The example turns into: |
d266a988 TR |
520 | + |
521 | ----------------------------------------------------------------------- | |
522 | .-A---M---N---O | |
523 | / / / | |
524 | I B D | |
525 | \ / / | |
526 | `---------' | |
527 | ----------------------------------------------------------------------- | |
528 | + | |
19d6eb41 | 529 | Note the major differences in `N`, `P`, and `Q` over `--full-history`: |
d266a988 TR |
530 | + |
531 | -- | |
532 | * `N`'s parent list had `I` removed, because it is an ancestor of the | |
533 | other parent `M`. Still, `N` remained because it is !TREESAME. | |
534 | + | |
535 | * `P`'s parent list similarly had `I` removed. `P` was then | |
536 | removed completely, because it had one parent and is TREESAME. | |
143f1eaf KB |
537 | + |
538 | * `Q`'s parent list had `Y` simplified to `X`. `X` was then removed, because it | |
539 | was a TREESAME root. `Q` was then removed completely, because it had one | |
540 | parent and is TREESAME. | |
d266a988 | 541 | -- |
fdcf39e5 | 542 | |
8d049e18 | 543 | There is another simplification mode available: |
57456ef4 JH |
544 | |
545 | --ancestry-path:: | |
57456ef4 | 546 | Limit the displayed commits to those directly on the ancestry |
4528aa1a JSJ |
547 | chain between the ``from'' and ``to'' commits in the given commit |
548 | range. I.e. only display commits that are ancestor of the ``to'' | |
19d6eb41 | 549 | commit and descendants of the ``from'' commit. |
57456ef4 JH |
550 | + |
551 | As an example use case, consider the following commit history: | |
552 | + | |
553 | ----------------------------------------------------------------------- | |
554 | D---E-------F | |
555 | / \ \ | |
556 | B---C---G---H---I---J | |
557 | / \ | |
558 | A-------K---------------L--M | |
559 | ----------------------------------------------------------------------- | |
560 | + | |
561 | A regular 'D..M' computes the set of commits that are ancestors of `M`, | |
562 | but excludes the ones that are ancestors of `D`. This is useful to see | |
563 | what happened to the history leading to `M` since `D`, in the sense | |
4528aa1a | 564 | that ``what does `M` have that did not exist in `D`''. The result in this |
57456ef4 JH |
565 | example would be all the commits, except `A` and `B` (and `D` itself, |
566 | of course). | |
567 | + | |
568 | When we want to find out what commits in `M` are contaminated with the | |
569 | bug introduced by `D` and need fixing, however, we might want to view | |
570 | only the subset of 'D..M' that are actually descendants of `D`, i.e. | |
4528aa1a | 571 | excluding `C` and `K`. This is exactly what the `--ancestry-path` |
57456ef4 JH |
572 | option does. Applied to the 'D..M' range, it results in: |
573 | + | |
574 | ----------------------------------------------------------------------- | |
575 | E-------F | |
576 | \ \ | |
577 | G---H---I---J | |
578 | \ | |
579 | L--M | |
580 | ----------------------------------------------------------------------- | |
581 | ||
8d049e18 DS |
582 | Before discussing another option, `--show-pulls`, we need to |
583 | create a new example history. | |
32f7037a | 584 | |
8d049e18 DS |
585 | A common problem users face when looking at simplified history is that a |
586 | commit they know changed a file somehow does not appear in the file's | |
587 | simplified history. Let's demonstrate a new example and show how options | |
588 | such as `--full-history` and `--simplify-merges` works in that case: | |
32f7037a | 589 | |
8d049e18 DS |
590 | ----------------------------------------------------------------------- |
591 | .-A---M-----C--N---O---P | |
592 | / / \ \ \/ / / | |
593 | I B \ R-'`-Z' / | |
594 | \ / \/ / | |
595 | \ / /\ / | |
596 | `---X--' `---Y--' | |
597 | ----------------------------------------------------------------------- | |
32f7037a | 598 | |
8d049e18 DS |
599 | For this example, suppose `I` created `file.txt` which was modified by |
600 | `A`, `B`, and `X` in different ways. The single-parent commits `C`, `Z`, | |
601 | and `Y` do not change `file.txt`. The merge commit `M` was created by | |
602 | resolving the merge conflict to include both changes from `A` and `B` | |
603 | and hence is not TREESAME to either. The merge commit `R`, however, was | |
604 | created by ignoring the contents of `file.txt` at `M` and taking only | |
605 | the contents of `file.txt` at `X`. Hence, `R` is TREESAME to `X` but not | |
606 | `M`. Finally, the natural merge resolution to create `N` is to take the | |
607 | contents of `file.txt` at `R`, so `N` is TREESAME to `R` but not `C`. | |
608 | The merge commits `O` and `P` are TREESAME to their first parents, but | |
609 | not to their second parents, `Z` and `Y` respectively. | |
32f7037a | 610 | |
8d049e18 DS |
611 | When using the default mode, `N` and `R` both have a TREESAME parent, so |
612 | those edges are walked and the others are ignored. The resulting history | |
613 | graph is: | |
32f7037a | 614 | |
8d049e18 DS |
615 | ----------------------------------------------------------------------- |
616 | I---X | |
617 | ----------------------------------------------------------------------- | |
32f7037a | 618 | |
8d049e18 DS |
619 | When using `--full-history`, Git walks every edge. This will discover |
620 | the commits `A` and `B` and the merge `M`, but also will reveal the | |
621 | merge commits `O` and `P`. With parent rewriting, the resulting graph is: | |
32f7037a | 622 | |
8d049e18 DS |
623 | ----------------------------------------------------------------------- |
624 | .-A---M--------N---O---P | |
625 | / / \ \ \/ / / | |
626 | I B \ R-'`--' / | |
627 | \ / \/ / | |
628 | \ / /\ / | |
629 | `---X--' `------' | |
630 | ----------------------------------------------------------------------- | |
32f7037a | 631 | |
8d049e18 DS |
632 | Here, the merge commits `O` and `P` contribute extra noise, as they did |
633 | not actually contribute a change to `file.txt`. They only merged a topic | |
634 | that was based on an older version of `file.txt`. This is a common | |
635 | issue in repositories using a workflow where many contributors work in | |
636 | parallel and merge their topic branches along a single trunk: manu | |
637 | unrelated merges appear in the `--full-history` results. | |
32f7037a | 638 | |
8d049e18 DS |
639 | When using the `--simplify-merges` option, the commits `O` and `P` |
640 | disappear from the results. This is because the rewritten second parents | |
641 | of `O` and `P` are reachable from their first parents. Those edges are | |
642 | removed and then the commits look like single-parent commits that are | |
643 | TREESAME to their parent. This also happens to the commit `N`, resulting | |
644 | in a history view as follows: | |
32f7037a | 645 | |
8d049e18 DS |
646 | ----------------------------------------------------------------------- |
647 | .-A---M--. | |
648 | / / \ | |
649 | I B R | |
650 | \ / / | |
651 | \ / / | |
652 | `---X--' | |
653 | ----------------------------------------------------------------------- | |
32f7037a | 654 | |
8d049e18 DS |
655 | In this view, we see all of the important single-parent changes from |
656 | `A`, `B`, and `X`. We also see the carefully-resolved merge `M` and the | |
657 | not-so-carefully-resolved merge `R`. This is usually enough information | |
658 | to determine why the commits `A` and `B` "disappeared" from history in | |
659 | the default view. However, there are a few issues with this approach. | |
32f7037a | 660 | |
8d049e18 DS |
661 | The first issue is performance. Unlike any previous option, the |
662 | `--simplify-merges` option requires walking the entire commit history | |
663 | before returning a single result. This can make the option difficult to | |
664 | use for very large repositories. | |
32f7037a | 665 | |
8d049e18 DS |
666 | The second issue is one of auditing. When many contributors are working |
667 | on the same repository, it is important which merge commits introduced | |
668 | a change into an important branch. The problematic merge `R` above is | |
669 | not likely to be the merge commit that was used to merge into an | |
670 | important branch. Instead, the merge `N` was used to merge `R` and `X` | |
671 | into the important branch. This commit may have information about why | |
672 | the change `X` came to override the changes from `A` and `B` in its | |
673 | commit message. | |
32f7037a MÅ |
674 | |
675 | --show-pulls:: | |
676 | In addition to the commits shown in the default history, show | |
677 | each merge commit that is not TREESAME to its first parent but | |
678 | is TREESAME to a later parent. | |
8d049e18 | 679 | + |
32f7037a | 680 | When a merge commit is included by `--show-pulls`, the merge is |
8d049e18 DS |
681 | treated as if it "pulled" the change from another branch. When using |
682 | `--show-pulls` on this example (and no other options) the resulting | |
683 | graph is: | |
684 | + | |
685 | ----------------------------------------------------------------------- | |
686 | I---X---R---N | |
687 | ----------------------------------------------------------------------- | |
688 | + | |
689 | Here, the merge commits `R` and `N` are included because they pulled | |
690 | the commits `X` and `R` into the base branch, respectively. These | |
691 | merges are the reason the commits `A` and `B` do not appear in the | |
692 | default history. | |
693 | + | |
694 | When `--show-pulls` is paired with `--simplify-merges`, the | |
695 | graph includes all of the necessary information: | |
696 | + | |
697 | ----------------------------------------------------------------------- | |
698 | .-A---M--. N | |
699 | / / \ / | |
700 | I B R | |
701 | \ / / | |
702 | \ / / | |
703 | `---X--' | |
704 | ----------------------------------------------------------------------- | |
705 | + | |
706 | Notice that since `M` is reachable from `R`, the edge from `N` to `M` | |
707 | was simplified away. However, `N` still appears in the history as an | |
708 | important commit because it "pulled" the change `R` into the main | |
709 | branch. | |
710 | ||
4528aa1a | 711 | The `--simplify-by-decoration` option allows you to view only the |
3fcfd662 NS |
712 | big picture of the topology of the history, by omitting commits |
713 | that are not referenced by tags. Commits are marked as !TREESAME | |
714 | (in other words, kept after history simplification rules described | |
715 | above) if (1) they are referenced by tags, or (2) they change the | |
716 | contents of the paths given on the command line. All other | |
717 | commits are marked as TREESAME (subject to be simplified away). | |
718 | ||
461caf3e | 719 | ifndef::git-shortlog[] |
fdcf39e5 | 720 | ifdef::git-rev-list[] |
70d9895e TR |
721 | Bisection Helpers |
722 | ~~~~~~~~~~~~~~~~~ | |
723 | ||
fdcf39e5 | 724 | --bisect:: |
4528aa1a JSJ |
725 | Limit output to the one commit object which is roughly halfway between |
726 | included and excluded commits. Note that the bad bisection ref | |
727 | `refs/bisect/bad` is added to the included commits (if it | |
728 | exists) and the good bisection refs `refs/bisect/good-*` are | |
729 | added to the excluded commits (if they exist). Thus, supposing there | |
730 | are no refs in `refs/bisect/`, if | |
731 | + | |
fdcf39e5 | 732 | ----------------------------------------------------------------------- |
6514aa36 | 733 | $ git rev-list --bisect foo ^bar ^baz |
fdcf39e5 | 734 | ----------------------------------------------------------------------- |
4528aa1a | 735 | + |
fdcf39e5 | 736 | outputs 'midpoint', the output of the two commands |
4528aa1a | 737 | + |
fdcf39e5 | 738 | ----------------------------------------------------------------------- |
6514aa36 CC |
739 | $ git rev-list foo ^midpoint |
740 | $ git rev-list midpoint ^bar ^baz | |
fdcf39e5 | 741 | ----------------------------------------------------------------------- |
4528aa1a | 742 | + |
fdcf39e5 MV |
743 | would be of roughly the same length. Finding the change which |
744 | introduces a regression is thus reduced to a binary search: repeatedly | |
745 | generate and test new 'midpoint's until the commit chain is of length | |
f88851c6 | 746 | one. Cannot be combined with --first-parent. |
fdcf39e5 MV |
747 | |
748 | --bisect-vars:: | |
4528aa1a JSJ |
749 | This calculates the same as `--bisect`, except that refs in |
750 | `refs/bisect/` are not used, and except that this outputs | |
751 | text ready to be eval'ed by the shell. These lines will assign the | |
752 | name of the midpoint revision to the variable `bisect_rev`, and the | |
753 | expected number of commits to be tested after `bisect_rev` is tested | |
754 | to `bisect_nr`, the expected number of commits to be tested if | |
755 | `bisect_rev` turns out to be good to `bisect_good`, the expected | |
756 | number of commits to be tested if `bisect_rev` turns out to be bad to | |
757 | `bisect_bad`, and the number of commits we are bisecting right now to | |
758 | `bisect_all`. | |
fdcf39e5 MV |
759 | |
760 | --bisect-all:: | |
4528aa1a JSJ |
761 | This outputs all the commit objects between the included and excluded |
762 | commits, ordered by their distance to the included and excluded | |
763 | commits. Refs in `refs/bisect/` are not used. The farthest | |
764 | from them is displayed first. (This is the only one displayed by | |
765 | `--bisect`.) | |
3d2d4f96 | 766 | + |
fdcf39e5 MV |
767 | This is useful because it makes it easy to choose a good commit to |
768 | test when you want to avoid to test some of them for some reason (they | |
769 | may not compile for example). | |
3d2d4f96 | 770 | + |
fdcf39e5 MV |
771 | This option can be used along with `--bisect-vars`, in this case, |
772 | after all the sorted commit objects, there will be the same text as if | |
773 | `--bisect-vars` had been used alone. | |
774 | endif::git-rev-list[] | |
461caf3e | 775 | endif::git-shortlog[] |
fdcf39e5 | 776 | |
461caf3e | 777 | ifndef::git-shortlog[] |
fdcf39e5 MV |
778 | Commit Ordering |
779 | ~~~~~~~~~~~~~~~ | |
780 | ||
781 | By default, the commits are shown in reverse chronological order. | |
782 | ||
3f0350cc JH |
783 | --date-order:: |
784 | Show no parents before all of its children are shown, but | |
785 | otherwise show commits in the commit timestamp order. | |
fdcf39e5 | 786 | |
81c6b38b JH |
787 | --author-date-order:: |
788 | Show no parents before all of its children are shown, but | |
789 | otherwise show commits in the author timestamp order. | |
790 | ||
3f0350cc JH |
791 | --topo-order:: |
792 | Show no parents before all of its children are shown, and | |
793 | avoid showing commits on multiple lines of history | |
794 | intermixed. | |
795 | + | |
796 | For example, in a commit history like this: | |
797 | + | |
798 | ---------------------------------------------------------------- | |
fdcf39e5 | 799 | |
3f0350cc JH |
800 | ---1----2----4----7 |
801 | \ \ | |
802 | 3----5----6----8--- | |
fdcf39e5 | 803 | |
3f0350cc JH |
804 | ---------------------------------------------------------------- |
805 | + | |
806 | where the numbers denote the order of commit timestamps, `git | |
807 | rev-list` and friends with `--date-order` show the commits in the | |
808 | timestamp order: 8 7 6 5 4 3 2 1. | |
809 | + | |
810 | With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5 | |
811 | 3 1); some older commits are shown before newer ones in order to | |
812 | avoid showing the commits from two parallel development track mixed | |
813 | together. | |
fdcf39e5 MV |
814 | |
815 | --reverse:: | |
04be6947 PB |
816 | Output the commits chosen to be shown (see Commit Limiting |
817 | section above) in reverse order. Cannot be combined with | |
818 | `--walk-reflogs`. | |
461caf3e | 819 | endif::git-shortlog[] |
fdcf39e5 | 820 | |
461caf3e | 821 | ifndef::git-shortlog[] |
fdcf39e5 MV |
822 | Object Traversal |
823 | ~~~~~~~~~~~~~~~~ | |
824 | ||
2de9b711 | 825 | These options are mostly targeted for packing of Git repositories. |
fdcf39e5 | 826 | |
3cab02de | 827 | ifdef::git-rev-list[] |
fdcf39e5 | 828 | --objects:: |
fdcf39e5 | 829 | Print the object IDs of any object referenced by the listed |
4528aa1a | 830 | commits. `--objects foo ^bar` thus means ``send me |
fdcf39e5 | 831 | all object IDs which I need to download if I have the commit |
4528aa1a | 832 | object _bar_ but not _foo_''. |
fdcf39e5 | 833 | |
ce5b6f9b SB |
834 | --in-commit-order:: |
835 | Print tree and blob ids in order of the commits. The tree | |
836 | and blob ids are printed after they are first referenced | |
837 | by a commit. | |
838 | ||
fdcf39e5 | 839 | --objects-edge:: |
4528aa1a JSJ |
840 | Similar to `--objects`, but also print the IDs of excluded |
841 | commits prefixed with a ``-'' character. This is used by | |
8297643f | 842 | linkgit:git-pack-objects[1] to build a ``thin'' pack, which records |
fdcf39e5 MV |
843 | objects in deltified form based on objects contained in these |
844 | excluded commits to reduce network traffic. | |
845 | ||
1684c1b2 | 846 | --objects-edge-aggressive:: |
847 | Similar to `--objects-edge`, but it tries harder to find excluded | |
2dacf26d | 848 | commits at the cost of increased time. This is used instead of |
849 | `--objects-edge` to build ``thin'' packs for shallow repositories. | |
1684c1b2 | 850 | |
3cab02de JH |
851 | --indexed-objects:: |
852 | Pretend as if all trees and blobs used by the index are listed | |
853 | on the command line. Note that you probably want to use | |
854 | `--objects`, too. | |
855 | ||
fdcf39e5 | 856 | --unpacked:: |
4528aa1a | 857 | Only useful with `--objects`; print the object IDs that are not |
fdcf39e5 | 858 | in packs. |
caf3827e | 859 | |
42357b4e ES |
860 | --object-names:: |
861 | Only useful with `--objects`; print the names of the object IDs | |
862 | that are found. This is the default behavior. | |
863 | ||
864 | --no-object-names:: | |
865 | Only useful with `--objects`; does not print the names of the object | |
866 | IDs that are found. This inverts `--object-names`. This flag allows | |
867 | the output to be more easily parsed by commands such as | |
868 | linkgit:git-cat-file[1]. | |
869 | ||
caf3827e JH |
870 | --filter=<filter-spec>:: |
871 | Only useful with one of the `--objects*`; omits objects (usually | |
872 | blobs) from the list of printed objects. The '<filter-spec>' | |
873 | may be one of the following: | |
874 | + | |
875 | The form '--filter=blob:none' omits all blobs. | |
876 | + | |
877 | The form '--filter=blob:limit=<n>[kmg]' omits blobs larger than n bytes | |
f4371a88 JH |
878 | or units. n may be zero. The suffixes k, m, and g can be used to name |
879 | units in KiB, MiB, or GiB. For example, 'blob:limit=1k' is the same | |
880 | as 'blob:limit=1024'. | |
caf3827e | 881 | + |
f4371a88 JH |
882 | The form '--filter=sparse:oid=<blob-ish>' uses a sparse-checkout |
883 | specification contained in the blob (or blob-expression) '<blob-ish>' | |
884 | to omit blobs that would not be not required for a sparse checkout on | |
885 | the requested refs. | |
caf3827e | 886 | + |
bc5975d2 MD |
887 | The form '--filter=tree:<depth>' omits all blobs and trees whose depth |
888 | from the root tree is >= <depth> (minimum depth if an object is located | |
c813a7c3 MD |
889 | at multiple depths in the commits traversed). <depth>=0 will not include |
890 | any trees or blobs unless included explicitly in the command-line (or | |
891 | standard input when --stdin is used). <depth>=1 will include only the | |
892 | tree and blobs which are referenced directly by a commit reachable from | |
893 | <commit> or an explicitly-given object. <depth>=2 is like <depth>=1 | |
894 | while also including trees and blobs one more level removed from an | |
895 | explicitly-given commit or tree. | |
e693237e CC |
896 | + |
897 | Note that the form '--filter=sparse:path=<path>' that wants to read | |
898 | from an arbitrary path on the filesystem has been dropped for security | |
899 | reasons. | |
489fc9ee MD |
900 | + |
901 | Multiple '--filter=' flags can be specified to combine filters. Only | |
902 | objects which are accepted by every filter are included. | |
903 | + | |
904 | The form '--filter=combine:<filter1>+<filter2>+...<filterN>' can also be | |
905 | used to combined several filters, but this is harder than just repeating | |
906 | the '--filter' flag and is usually not necessary. Filters are joined by | |
907 | '{plus}' and individual filters are %-encoded (i.e. URL-encoded). | |
908 | Besides the '{plus}' and '%' characters, the following characters are | |
909 | reserved and also must be encoded: `~!@#$^&*()[]{}\;",<>?`+'`+ | |
910 | as well as all characters with ASCII code <= `0x20`, which includes | |
911 | space and newline. | |
912 | + | |
913 | Other arbitrary characters can also be encoded. For instance, | |
914 | 'combine:tree:3+blob:none' and 'combine:tree%3A3+blob%3Anone' are | |
915 | equivalent. | |
caf3827e | 916 | |
f4371a88 JH |
917 | --no-filter:: |
918 | Turn off any previous `--filter=` argument. | |
919 | ||
caf3827e JH |
920 | --filter-print-omitted:: |
921 | Only useful with `--filter=`; prints a list of the objects omitted | |
8d75a1d1 | 922 | by the filter. Object IDs are prefixed with a ``~'' character. |
caf3827e JH |
923 | |
924 | --missing=<missing-action>:: | |
925 | A debug option to help with future "partial clone" development. | |
926 | This option specifies how missing objects are handled. | |
927 | + | |
928 | The form '--missing=error' requests that rev-list stop with an error if | |
929 | a missing object is encountered. This is the default action. | |
930 | + | |
931 | The form '--missing=allow-any' will allow object traversal to continue | |
932 | if a missing object is encountered. Missing objects will silently be | |
933 | omitted from the results. | |
934 | + | |
df11e196 JT |
935 | The form '--missing=allow-promisor' is like 'allow-any', but will only |
936 | allow object traversal to continue for EXPECTED promisor missing objects. | |
937 | Unexpected missing objects will raise an error. | |
938 | + | |
caf3827e JH |
939 | The form '--missing=print' is like 'allow-any', but will also print a |
940 | list of the missing objects. Object IDs are prefixed with a ``?'' character. | |
fdcf39e5 | 941 | |
df11e196 JT |
942 | --exclude-promisor-objects:: |
943 | (For internal use only.) Prefilter object traversal at | |
944 | promisor boundary. This is used with partial clone. This is | |
945 | stronger than `--missing=allow-promisor` because it limits the | |
946 | traversal, rather than just silencing errors about missing | |
947 | objects. | |
368a8912 | 948 | endif::git-rev-list[] |
df11e196 | 949 | |
ca92e59e | 950 | --no-walk[=(sorted|unsorted)]:: |
ca92e59e MZ |
951 | Only show the given commits, but do not traverse their ancestors. |
952 | This has no effect if a range is specified. If the argument | |
19d6eb41 | 953 | `unsorted` is given, the commits are shown in the order they were |
4528aa1a | 954 | given on the command line. Otherwise (if `sorted` or no argument |
19d6eb41 | 955 | was given), the commits are shown in reverse chronological order |
ca92e59e | 956 | by commit time. |
695985f4 | 957 | Cannot be combined with `--graph`. |
fdcf39e5 MV |
958 | |
959 | --do-walk:: | |
4528aa1a | 960 | Overrides a previous `--no-walk`. |
461caf3e | 961 | endif::git-shortlog[] |
f98fd436 | 962 | |
461caf3e | 963 | ifndef::git-shortlog[] |
f98fd436 MG |
964 | Commit Formatting |
965 | ~~~~~~~~~~~~~~~~~ | |
966 | ||
967 | ifdef::git-rev-list[] | |
968 | Using these options, linkgit:git-rev-list[1] will act similar to the | |
969 | more specialized family of commit log tools: linkgit:git-log[1], | |
970 | linkgit:git-show[1], and linkgit:git-whatchanged[1] | |
971 | endif::git-rev-list[] | |
972 | ||
973 | include::pretty-options.txt[] | |
974 | ||
975 | --relative-date:: | |
f98fd436 MG |
976 | Synonym for `--date=relative`. |
977 | ||
4b1c5e1d | 978 | --date=<format>:: |
f98fd436 | 979 | Only takes effect for dates shown in human-readable format, such |
4528aa1a | 980 | as when using `--pretty`. `log.date` config variable sets a default |
add00ba2 JK |
981 | value for the log command's `--date` option. By default, dates |
982 | are shown in the original time zone (either committer's or | |
983 | author's). If `-local` is appended to the format (e.g., | |
984 | `iso-local`), the user's local time zone is used instead. | |
f98fd436 | 985 | + |
39a869b2 | 986 | -- |
f98fd436 | 987 | `--date=relative` shows dates relative to the current time, |
1a2a1e8e JK |
988 | e.g. ``2 hours ago''. The `-local` option has no effect for |
989 | `--date=relative`. | |
39a869b2 | 990 | |
add00ba2 | 991 | `--date=local` is an alias for `--date=default-local`. |
39a869b2 | 992 | |
466fb674 BB |
993 | `--date=iso` (or `--date=iso8601`) shows timestamps in a ISO 8601-like format. |
994 | The differences to the strict ISO 8601 format are: | |
995 | ||
996 | - a space instead of the `T` date/time delimiter | |
997 | - a space between time and time zone | |
998 | - no colon between hours and minutes of the time zone | |
999 | ||
466fb674 BB |
1000 | `--date=iso-strict` (or `--date=iso8601-strict`) shows timestamps in strict |
1001 | ISO 8601 format. | |
39a869b2 | 1002 | |
f98fd436 | 1003 | `--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822 |
19d6eb41 | 1004 | format, often found in email messages. |
39a869b2 | 1005 | |
19d6eb41 | 1006 | `--date=short` shows only the date, but not the time, in `YYYY-MM-DD` format. |
39a869b2 | 1007 | |
442f6fd3 JH |
1008 | `--date=raw` shows the date as seconds since the epoch (1970-01-01 |
1009 | 00:00:00 UTC), followed by a space, and then the timezone as an offset | |
1010 | from UTC (a `+` or `-` with four digits; the first two are hours, and | |
1011 | the second two are minutes). I.e., as if the timestamp were formatted | |
1012 | with `strftime("%s %z")`). | |
1a2a1e8e JK |
1013 | Note that the `-local` option does not affect the seconds-since-epoch |
1014 | value (which is always measured in UTC), but does switch the accompanying | |
1015 | timezone value. | |
39a869b2 | 1016 | |
038a8788 SS |
1017 | `--date=human` shows the timezone if the timezone does not match the |
1018 | current time-zone, and doesn't print the whole date if that matches | |
1019 | (ie skip printing year for dates that are "this year", but also skip | |
1020 | the whole date itself if it's in the last few days and we can just say | |
1021 | what weekday it was). For older dates the hour and minute is also | |
1022 | omitted. | |
39a869b2 | 1023 | |
642833db JK |
1024 | `--date=unix` shows the date as a Unix epoch timestamp (seconds since |
1025 | 1970). As with `--raw`, this is always in UTC and therefore `-local` | |
1026 | has no effect. | |
39a869b2 | 1027 | |
c3fbf81a RS |
1028 | `--date=format:...` feeds the format `...` to your system `strftime`, |
1029 | except for %z and %Z, which are handled internally. | |
aa1462cc JK |
1030 | Use `--date=format:%c` to show the date in your system locale's |
1031 | preferred format. See the `strftime` manual for a complete list of | |
add00ba2 JK |
1032 | format placeholders. When using `-local`, the correct syntax is |
1033 | `--date=format-local:...`. | |
39a869b2 | 1034 | |
add00ba2 JK |
1035 | `--date=default` is the default format, and is similar to |
1036 | `--date=rfc2822`, with a few exceptions: | |
39a869b2 | 1037 | -- |
add00ba2 JK |
1038 | - there is no comma after the day-of-week |
1039 | ||
1040 | - the time zone is omitted when the local time zone is used | |
f98fd436 MG |
1041 | |
1042 | ifdef::git-rev-list[] | |
1043 | --header:: | |
f98fd436 MG |
1044 | Print the contents of the commit in raw-format; each record is |
1045 | separated with a NUL character. | |
1046 | endif::git-rev-list[] | |
1047 | ||
1048 | --parents:: | |
f98fd436 | 1049 | Print also the parents of the commit (in the form "commit parent..."). |
4f851dc8 | 1050 | Also enables parent rewriting, see 'History Simplification' above. |
f98fd436 MG |
1051 | |
1052 | --children:: | |
f98fd436 | 1053 | Print also the children of the commit (in the form "commit child..."). |
4f851dc8 | 1054 | Also enables parent rewriting, see 'History Simplification' above. |
f98fd436 MG |
1055 | |
1056 | ifdef::git-rev-list[] | |
1057 | --timestamp:: | |
1058 | Print the raw commit timestamp. | |
1059 | endif::git-rev-list[] | |
1060 | ||
1061 | --left-right:: | |
27ac8371 | 1062 | Mark which side of a symmetric difference a commit is reachable from. |
f98fd436 MG |
1063 | Commits from the left side are prefixed with `<` and those from |
1064 | the right with `>`. If combined with `--boundary`, those | |
1065 | commits are prefixed with `-`. | |
1066 | + | |
1067 | For example, if you have this topology: | |
1068 | + | |
1069 | ----------------------------------------------------------------------- | |
1070 | y---b---b branch B | |
1071 | / \ / | |
1072 | / . | |
1073 | / / \ | |
1074 | o---x---a---a branch A | |
1075 | ----------------------------------------------------------------------- | |
1076 | + | |
1077 | you would get an output like this: | |
1078 | + | |
1079 | ----------------------------------------------------------------------- | |
1080 | $ git rev-list --left-right --boundary --pretty=oneline A...B | |
1081 | ||
1082 | >bbbbbbb... 3rd on b | |
1083 | >bbbbbbb... 2nd on b | |
1084 | <aaaaaaa... 3rd on a | |
1085 | <aaaaaaa... 2nd on a | |
1086 | -yyyyyyy... 1st on b | |
1087 | -xxxxxxx... 1st on a | |
1088 | ----------------------------------------------------------------------- | |
1089 | ||
1090 | --graph:: | |
f98fd436 MG |
1091 | Draw a text-based graphical representation of the commit history |
1092 | on the left hand side of the output. This may cause extra lines | |
1093 | to be printed in between commits, in order for the graph history | |
1094 | to be drawn properly. | |
695985f4 | 1095 | Cannot be combined with `--no-walk`. |
f98fd436 | 1096 | + |
4f851dc8 | 1097 | This enables parent rewriting, see 'History Simplification' above. |
f98fd436 | 1098 | + |
4528aa1a JSJ |
1099 | This implies the `--topo-order` option by default, but the |
1100 | `--date-order` option may also be specified. | |
f98fd436 | 1101 | |
1b32dece NTND |
1102 | --show-linear-break[=<barrier>]:: |
1103 | When --graph is not used, all history branches are flattened | |
1104 | which can make it hard to see that the two consecutive commits | |
1105 | do not belong to a linear branch. This option puts a barrier | |
1106 | in between them in that case. If `<barrier>` is specified, it | |
1107 | is the string that will be shown instead of the default one. | |
1108 | ||
f98fd436 MG |
1109 | ifdef::git-rev-list[] |
1110 | --count:: | |
1111 | Print a number stating how many commits would have been | |
1112 | listed, and suppress all other output. When used together | |
4528aa1a | 1113 | with `--left-right`, instead print the counts for left and |
b388e14b | 1114 | right commits, separated by a tab. When used together with |
4528aa1a | 1115 | `--cherry-mark`, omit patch equivalent commits from these |
b388e14b MG |
1116 | counts and print the count for equivalent commits separated |
1117 | by a tab. | |
f98fd436 | 1118 | endif::git-rev-list[] |
461caf3e | 1119 | endif::git-shortlog[] |
f98fd436 | 1120 | |
461caf3e | 1121 | ifndef::git-shortlog[] |
f98fd436 MG |
1122 | ifndef::git-rev-list[] |
1123 | Diff Formatting | |
1124 | ~~~~~~~~~~~~~~~ | |
1125 | ||
19d6eb41 | 1126 | Listed below are options that control the formatting of diff output. |
f98fd436 MG |
1127 | Some of them are specific to linkgit:git-rev-list[1], however other diff |
1128 | options may be given. See linkgit:git-diff-files[1] for more options. | |
1129 | ||
1130 | -c:: | |
f98fd436 MG |
1131 | With this option, diff output for a merge commit |
1132 | shows the differences from each of the parents to the merge result | |
1133 | simultaneously instead of showing pairwise diff between a parent | |
1134 | and the result one at a time. Furthermore, it lists only files | |
1135 | which were modified from all parents. | |
1136 | ||
1137 | --cc:: | |
4528aa1a | 1138 | This flag implies the `-c` option and further compresses the |
f98fd436 MG |
1139 | patch output by omitting uninteresting hunks whose contents in |
1140 | the parents have only two variants and the merge result picks | |
1141 | one of them without modification. | |
1142 | ||
d76ce4f7 EN |
1143 | --combined-all-paths:: |
1144 | This flag causes combined diffs (used for merge commits) to | |
1145 | list the name of the file from all parents. It thus only has | |
1146 | effect when -c or --cc are specified, and is likely only | |
1147 | useful if filename changes are detected (i.e. when either | |
1148 | rename or copy detection have been requested). | |
1149 | ||
f98fd436 | 1150 | -m:: |
f98fd436 MG |
1151 | This flag makes the merge commits show the full diff like |
1152 | regular commits; for each merge parent, a separate log entry | |
1153 | and diff is generated. An exception is that only diff against | |
4528aa1a | 1154 | the first parent is shown when `--first-parent` option is given; |
f98fd436 MG |
1155 | in that case, the output represents the changes the merge |
1156 | brought _into_ the then-current branch. | |
1157 | ||
1158 | -r:: | |
f98fd436 MG |
1159 | Show recursive diffs. |
1160 | ||
1161 | -t:: | |
4528aa1a | 1162 | Show the tree objects in the diff output. This implies `-r`. |
f98fd436 | 1163 | endif::git-rev-list[] |
461caf3e | 1164 | endif::git-shortlog[] |