Teach git diff about BibTeX head hunk patterns
[git/git.git] / Documentation / rev-list-options.txt
CommitLineData
fdcf39e5
MV
1Commit Formatting
2~~~~~~~~~~~~~~~~~
3
4ifdef::git-rev-list[]
5Using these options, linkgit:git-rev-list[1] will act similar to the
6more specialized family of commit log tools: linkgit:git-log[1],
7linkgit:git-show[1], and linkgit:git-whatchanged[1]
8endif::git-rev-list[]
9
10include::pretty-options.txt[]
11
12--relative-date::
13
14 Synonym for `--date=relative`.
15
26b4d003 16--date={relative,local,default,iso,rfc,short}::
fdcf39e5
MV
17
18 Only takes effect for dates shown in human-readable format, such
dd0ffd5b
HO
19 as when using "--pretty". `log.date` config variable sets a default
20 value for log command's --date option.
fdcf39e5
MV
21+
22`--date=relative` shows dates relative to the current time,
23e.g. "2 hours ago".
24+
25`--date=local` shows timestamps in user's local timezone.
26+
27`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
28+
29`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
30format, often found in E-mail messages.
31+
32`--date=short` shows only date but not time, in `YYYY-MM-DD` format.
33+
34`--date=default` shows timestamps in the original timezone
35(either committer's or author's).
36
adf60f14 37ifdef::git-rev-list[]
fdcf39e5
MV
38--header::
39
40 Print the contents of the commit in raw-format; each record is
41 separated with a NUL character.
adf60f14 42endif::git-rev-list[]
fdcf39e5
MV
43
44--parents::
45
46 Print the parents of the commit.
47
72276a3e
JH
48--children::
49
50 Print the children of the commit.
51
adf60f14 52ifdef::git-rev-list[]
fdcf39e5
MV
53--timestamp::
54 Print the raw commit timestamp.
adf60f14 55endif::git-rev-list[]
fdcf39e5
MV
56
57--left-right::
58
59 Mark which side of a symmetric diff a commit is reachable from.
60 Commits from the left side are prefixed with `<` and those from
61 the right with `>`. If combined with `--boundary`, those
62 commits are prefixed with `-`.
63+
64For example, if you have this topology:
65+
66-----------------------------------------------------------------------
67 y---b---b branch B
68 / \ /
69 / .
70 / / \
71 o---x---a---a branch A
72-----------------------------------------------------------------------
73+
d777af86 74you would get an output like this:
fdcf39e5
MV
75+
76-----------------------------------------------------------------------
77 $ git rev-list --left-right --boundary --pretty=oneline A...B
78
79 >bbbbbbb... 3rd on b
80 >bbbbbbb... 2nd on b
81 <aaaaaaa... 3rd on a
82 <aaaaaaa... 2nd on a
83 -yyyyyyy... 1st on b
84 -xxxxxxx... 1st on a
85-----------------------------------------------------------------------
86
7fefda5c
AS
87--graph::
88
89 Draw a text-based graphical representation of the commit history
90 on the left hand side of the output. This may cause extra lines
91 to be printed in between commits, in order for the graph history
92 to be drawn properly.
93+
94This implies the '--topo-order' option by default, but the
95'--date-order' option may also be specified.
96
fdcf39e5
MV
97Diff Formatting
98~~~~~~~~~~~~~~~
99
100Below are listed options that control the formatting of diff output.
101Some of them are specific to linkgit:git-rev-list[1], however other diff
102options may be given. See linkgit:git-diff-files[1] for more options.
103
104-c::
105
106 This flag changes the way a merge commit is displayed. It shows
107 the differences from each of the parents to the merge result
108 simultaneously instead of showing pairwise diff between a parent
109 and the result one at a time. Furthermore, it lists only files
110 which were modified from all parents.
111
112--cc::
113
114 This flag implies the '-c' options and further compresses the
ea3d988d
JH
115 patch output by omitting uninteresting hunks whose contents in
116 the parents have only two variants and the merge result picks
117 one of them without modification.
fdcf39e5
MV
118
119-r::
120
121 Show recursive diffs.
122
123-t::
124
125 Show the tree objects in the diff output. This implies '-r'.
126
127Commit Limiting
128~~~~~~~~~~~~~~~
129
130Besides specifying a range of commits that should be listed using the
131special notations explained in the description, additional commit
132limiting may be applied.
133
134--
135
3240240f
SB
136-n 'number'::
137--max-count='number'::
fdcf39e5
MV
138
139 Limit the number of commits output.
140
141--skip='number'::
142
143 Skip 'number' commits before starting to show the commit output.
144
3240240f
SB
145--since='date'::
146--after='date'::
fdcf39e5
MV
147
148 Show commits more recent than a specific date.
149
3240240f
SB
150--until='date'::
151--before='date'::
fdcf39e5
MV
152
153 Show commits older than a specific date.
154
56b6d01d 155ifdef::git-rev-list[]
3240240f
SB
156--max-age='timestamp'::
157--min-age='timestamp'::
fdcf39e5
MV
158
159 Limit the commits output to specified time range.
56b6d01d 160endif::git-rev-list[]
fdcf39e5 161
3240240f
SB
162--author='pattern'::
163--committer='pattern'::
fdcf39e5
MV
164
165 Limit the commits output to ones with author/committer
166 header lines that match the specified pattern (regular expression).
167
168--grep='pattern'::
169
170 Limit the commits output to ones with log message that
171 matches the specified pattern (regular expression).
172
3240240f
SB
173-i::
174--regexp-ignore-case::
fdcf39e5
MV
175
176 Match the regexp limiting patterns without regard to letters case.
177
3240240f
SB
178-E::
179--extended-regexp::
fdcf39e5
MV
180
181 Consider the limiting patterns to be extended regular expressions
182 instead of the default basic regular expressions.
183
3240240f
SB
184-F::
185--fixed-strings::
dc1c0fff
JN
186
187 Consider the limiting patterns to be fixed strings (don't interpret
188 pattern as a regular expression).
189
fdcf39e5
MV
190--remove-empty::
191
192 Stop when a given path disappears from the tree.
193
194--full-history::
195
196 Show also parts of history irrelevant to current state of a given
197 path. This turns off history simplification, which removed merges
198 which didn't change anything at all at some child. It will still actually
199 simplify away merges that didn't change anything at all into either
200 child.
201
202--no-merges::
203
204 Do not print commits with more than one parent.
205
206--first-parent::
207 Follow only the first parent commit upon seeing a merge
208 commit. This option can give a better overview when
209 viewing the evolution of a particular topic branch,
210 because merges into a topic branch tend to be only about
211 adjusting to updated upstream from time to time, and
212 this option allows you to ignore the individual commits
213 brought in to your history by such a merge.
214
215--not::
216
217 Reverses the meaning of the '{caret}' prefix (or lack thereof)
218 for all following revision specifiers, up to the next '--not'.
219
220--all::
221
222 Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
223 command line as '<commit>'.
224
adf60f14 225ifdef::git-rev-list[]
fdcf39e5
MV
226--stdin::
227
228 In addition to the '<commit>' listed on the command
229 line, read them from the standard input.
230
231--quiet::
232
233 Don't print anything to standard output. This form
234 is primarily meant to allow the caller to
235 test the exit status to see if a range of objects is fully
236 connected (or not). It is faster than redirecting stdout
237 to /dev/null as the output does not have to be formatted.
adf60f14 238endif::git-rev-list[]
fdcf39e5
MV
239
240--cherry-pick::
241
242 Omit any commit that introduces the same change as
243 another commit on the "other side" when the set of
244 commits are limited with symmetric difference.
245+
246For example, if you have two branches, `A` and `B`, a usual way
247to list all commits on only one side of them is with
248`--left-right`, like the example above in the description of
249that option. It however shows the commits that were cherry-picked
250from the other branch (for example, "3rd on b" may be cherry-picked
251from branch A). With this option, such pairs of commits are
252excluded from the output.
253
3240240f
SB
254-g::
255--walk-reflogs::
fdcf39e5
MV
256
257 Instead of walking the commit ancestry chain, walk
258 reflog entries from the most recent one to older ones.
259 When this option is used you cannot specify commits to
260 exclude (that is, '{caret}commit', 'commit1..commit2',
261 nor 'commit1...commit2' notations cannot be used).
262+
263With '\--pretty' format other than oneline (for obvious reasons),
264this causes the output to have two extra lines of information
265taken from the reflog. By default, 'commit@\{Nth}' notation is
266used in the output. When the starting commit is specified as
18a2197e 267'commit@\{now}', output also uses 'commit@\{timestamp}' notation
fdcf39e5
MV
268instead. Under '\--pretty=oneline', the commit message is
269prefixed with this information on the same line.
e534735a 270This option cannot be combined with '\--reverse'.
fdcf39e5
MV
271See also linkgit:git-reflog[1].
272
273--merge::
274
275 After a failed merge, show refs that touch files having a
276 conflict and don't exist on all heads to merge.
277
278--boundary::
279
280 Output uninteresting commits at the boundary, which are usually
281 not shown.
282
3240240f
SB
283--dense::
284--sparse::
fdcf39e5
MV
285
286When optional paths are given, the default behaviour ('--dense') is to
287only output commits that changes at least one of them, and also ignore
288merges that do not touch the given paths.
289
290Use the '--sparse' flag to makes the command output all eligible commits
291(still subject to count and age limitation), but apply merge
292simplification nevertheless.
293
294ifdef::git-rev-list[]
295--bisect::
296
297Limit output to the one commit object which is roughly halfway between
298the included and excluded commits. Thus, if
299
300-----------------------------------------------------------------------
301 $ git-rev-list --bisect foo ^bar ^baz
302-----------------------------------------------------------------------
303
304outputs 'midpoint', the output of the two commands
305
306-----------------------------------------------------------------------
307 $ git-rev-list foo ^midpoint
308 $ git-rev-list midpoint ^bar ^baz
309-----------------------------------------------------------------------
310
311would be of roughly the same length. Finding the change which
312introduces a regression is thus reduced to a binary search: repeatedly
313generate and test new 'midpoint's until the commit chain is of length
314one.
315
316--bisect-vars::
317
318This calculates the same as `--bisect`, but outputs text ready
319to be eval'ed by the shell. These lines will assign the name of
320the midpoint revision to the variable `bisect_rev`, and the
321expected number of commits to be tested after `bisect_rev` is
322tested to `bisect_nr`, the expected number of commits to be
323tested if `bisect_rev` turns out to be good to `bisect_good`,
324the expected number of commits to be tested if `bisect_rev`
325turns out to be bad to `bisect_bad`, and the number of commits
326we are bisecting right now to `bisect_all`.
327
328--bisect-all::
329
330This outputs all the commit objects between the included and excluded
331commits, ordered by their distance to the included and excluded
332commits. The farthest from them is displayed first. (This is the only
333one displayed by `--bisect`.)
334
335This is useful because it makes it easy to choose a good commit to
336test when you want to avoid to test some of them for some reason (they
337may not compile for example).
338
339This option can be used along with `--bisect-vars`, in this case,
340after all the sorted commit objects, there will be the same text as if
341`--bisect-vars` had been used alone.
342endif::git-rev-list[]
343
344--
345
346Commit Ordering
347~~~~~~~~~~~~~~~
348
349By default, the commits are shown in reverse chronological order.
350
351--topo-order::
352
353 This option makes them appear in topological order (i.e.
354 descendant commits are shown before their parents).
355
356--date-order::
357
358 This option is similar to '--topo-order' in the sense that no
359 parent comes before all of its children, but otherwise things
360 are still ordered in the commit timestamp order.
361
362--reverse::
363
364 Output the commits in reverse order.
365 Cannot be combined with '\--walk-reflogs'.
366
367Object Traversal
368~~~~~~~~~~~~~~~~
369
370These options are mostly targeted for packing of git repositories.
371
372--objects::
373
374 Print the object IDs of any object referenced by the listed
375 commits. '--objects foo ^bar' thus means "send me
376 all object IDs which I need to download if I have the commit
377 object 'bar', but not 'foo'".
378
379--objects-edge::
380
381 Similar to '--objects', but also print the IDs of excluded
382 commits prefixed with a "-" character. This is used by
383 linkgit:git-pack-objects[1] to build "thin" pack, which records
384 objects in deltified form based on objects contained in these
385 excluded commits to reduce network traffic.
386
387--unpacked::
388
389 Only useful with '--objects'; print the object IDs that are not
390 in packs.
391
392--no-walk::
393
394 Only show the given revs, but do not traverse their ancestors.
395
396--do-walk::
397
398 Overrides a previous --no-walk.