blob: b6f5d87e723bec4f00a3929274c43bfd478cc083 [file] [log] [blame]
Junio C Hamanob0e02952008-01-19 08:02:001Commit 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
14Synonym for `--date=relative`.
15
Junio C Hamanob713ff12008-05-24 01:12:3016--date={relative,local,default,iso,rfc,short}::
Junio C Hamanob0e02952008-01-19 08:02:0017
18Only takes effect for dates shown in human-readable format, such
Junio C Hamanob713ff12008-05-24 01:12:3019as when using "--pretty". `log.date` config variable sets a default
20value for log command's --date option.
Junio C Hamanob0e02952008-01-19 08:02:0021+
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
Junio C Hamano69cd7c52008-06-04 07:52:5937ifdef::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:0038--header::
39
40Print the contents of the commit in raw-format; each record is
41separated with a NUL character.
Junio C Hamano69cd7c52008-06-04 07:52:5942endif::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:0043
44--parents::
45
46Print the parents of the commit.
47
Junio C Hamano46a38aa2008-07-14 03:13:2748--children::
49
50Print the children of the commit.
51
Junio C Hamano69cd7c52008-06-04 07:52:5952ifdef::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:0053--timestamp::
54Print the raw commit timestamp.
Junio C Hamano69cd7c52008-06-04 07:52:5955endif::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:0056
57--left-right::
58
59Mark which side of a symmetric diff a commit is reachable from.
60Commits from the left side are prefixed with `<` and those from
61the right with `>`. If combined with `--boundary`, those
62commits 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+
74you would get an output line this:
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
Junio C Hamanofeeb1be2008-05-22 00:53:3587--graph::
88
89Draw a text-based graphical representation of the commit history
90on the left hand side of the output. This may cause extra lines
91to be printed in between commits, in order for the graph history
92to be drawn properly.
93+
94This implies the '--topo-order' option by default, but the
95'--date-order' option may also be specified.
96
Junio C Hamanob0e02952008-01-19 08:02:0097Diff 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
106This flag changes the way a merge commit is displayed. It shows
107the differences from each of the parents to the merge result
108simultaneously instead of showing pairwise diff between a parent
109and the result one at a time. Furthermore, it lists only files
110which were modified from all parents.
111
112--cc::
113
114This flag implies the '-c' options and further compresses the
115patch output by omitting hunks that show differences from only
116one parent, or show the same change from all but one parent for
117an Octopus merge.
118
119-r::
120
121Show recursive diffs.
122
123-t::
124
125Show 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
Junio C Hamanoeb415992008-06-08 22:49:47136-n 'number'::
137--max-count='number'::
Junio C Hamanob0e02952008-01-19 08:02:00138
139Limit the number of commits output.
140
141--skip='number'::
142
143Skip 'number' commits before starting to show the commit output.
144
Junio C Hamanoeb415992008-06-08 22:49:47145--since='date'::
146--after='date'::
Junio C Hamanob0e02952008-01-19 08:02:00147
148Show commits more recent than a specific date.
149
Junio C Hamanoeb415992008-06-08 22:49:47150--until='date'::
151--before='date'::
Junio C Hamanob0e02952008-01-19 08:02:00152
153Show commits older than a specific date.
154
Junio C Hamano4f1d8c42008-03-03 02:01:16155ifdef::git-rev-list[]
Junio C Hamanoeb415992008-06-08 22:49:47156--max-age='timestamp'::
157--min-age='timestamp'::
Junio C Hamanob0e02952008-01-19 08:02:00158
159Limit the commits output to specified time range.
Junio C Hamano4f1d8c42008-03-03 02:01:16160endif::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:00161
Junio C Hamanoeb415992008-06-08 22:49:47162--author='pattern'::
163--committer='pattern'::
Junio C Hamanob0e02952008-01-19 08:02:00164
165Limit the commits output to ones with author/committer
166header lines that match the specified pattern (regular expression).
167
168--grep='pattern'::
169
170Limit the commits output to ones with log message that
171matches the specified pattern (regular expression).
172
Junio C Hamanoeb415992008-06-08 22:49:47173-i::
174--regexp-ignore-case::
Junio C Hamanob0e02952008-01-19 08:02:00175
176Match the regexp limiting patterns without regard to letters case.
177
Junio C Hamanoeb415992008-06-08 22:49:47178-E::
179--extended-regexp::
Junio C Hamanob0e02952008-01-19 08:02:00180
181Consider the limiting patterns to be extended regular expressions
182instead of the default basic regular expressions.
183
Junio C Hamanoeb415992008-06-08 22:49:47184-F::
185--fixed-strings::
Junio C Hamano24bc09a2008-02-28 00:27:44186
187Consider the limiting patterns to be fixed strings (don't interpret
188pattern as a regular expression).
189
Junio C Hamanob0e02952008-01-19 08:02:00190--remove-empty::
191
192Stop when a given path disappears from the tree.
193
194--full-history::
195
196Show also parts of history irrelevant to current state of a given
197path. This turns off history simplification, which removed merges
198which didn't change anything at all at some child. It will still actually
199simplify away merges that didn't change anything at all into either
200child.
201
202--no-merges::
203
204Do not print commits with more than one parent.
205
206--first-parent::
207Follow only the first parent commit upon seeing a merge
208commit. This option can give a better overview when
209viewing the evolution of a particular topic branch,
210because merges into a topic branch tend to be only about
211adjusting to updated upstream from time to time, and
212this option allows you to ignore the individual commits
213brought in to your history by such a merge.
214
215--not::
216
217Reverses the meaning of the '{caret}' prefix (or lack thereof)
218for all following revision specifiers, up to the next '--not'.
219
220--all::
221
222Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
223command line as '<commit>'.
224
Junio C Hamano69cd7c52008-06-04 07:52:59225ifdef::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:00226--stdin::
227
228In addition to the '<commit>' listed on the command
229line, read them from the standard input.
230
231--quiet::
232
233Don't print anything to standard output. This form
234is primarily meant to allow the caller to
235test the exit status to see if a range of objects is fully
236connected (or not). It is faster than redirecting stdout
237to /dev/null as the output does not have to be formatted.
Junio C Hamano69cd7c52008-06-04 07:52:59238endif::git-rev-list[]
Junio C Hamanob0e02952008-01-19 08:02:00239
240--cherry-pick::
241
242Omit any commit that introduces the same change as
243another commit on the "other side" when the set of
244commits 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
Junio C Hamanoeb415992008-06-08 22:49:47254-g::
255--walk-reflogs::
Junio C Hamanob0e02952008-01-19 08:02:00256
257Instead of walking the commit ancestry chain, walk
258reflog entries from the most recent one to older ones.
259When this option is used you cannot specify commits to
260exclude (that is, '{caret}commit', 'commit1..commit2',
261nor '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
267'commit@{now}', output also uses 'commit@\{timestamp}' notation
268instead. Under '\--pretty=oneline', the commit message is
269prefixed with this information on the same line.
270
271Cannot be combined with '\--reverse'.
272See also linkgit:git-reflog[1].
273
274--merge::
275
276After a failed merge, show refs that touch files having a
277conflict and don't exist on all heads to merge.
278
279--boundary::
280
281Output uninteresting commits at the boundary, which are usually
282not shown.
283
Junio C Hamanoeb415992008-06-08 22:49:47284--dense::
285--sparse::
Junio C Hamanob0e02952008-01-19 08:02:00286
287When optional paths are given, the default behaviour ('--dense') is to
288only output commits that changes at least one of them, and also ignore
289merges that do not touch the given paths.
290
291Use the '--sparse' flag to makes the command output all eligible commits
292(still subject to count and age limitation), but apply merge
293simplification nevertheless.
294
295ifdef::git-rev-list[]
296--bisect::
297
298Limit output to the one commit object which is roughly halfway between
299the included and excluded commits. Thus, if
300
301-----------------------------------------------------------------------
302$ git-rev-list --bisect foo ^bar ^baz
303-----------------------------------------------------------------------
304
305outputs 'midpoint', the output of the two commands
306
307-----------------------------------------------------------------------
308$ git-rev-list foo ^midpoint
309$ git-rev-list midpoint ^bar ^baz
310-----------------------------------------------------------------------
311
312would be of roughly the same length. Finding the change which
313introduces a regression is thus reduced to a binary search: repeatedly
314generate and test new 'midpoint's until the commit chain is of length
315one.
316
317--bisect-vars::
318
319This calculates the same as `--bisect`, but outputs text ready
320to be eval'ed by the shell. These lines will assign the name of
321the midpoint revision to the variable `bisect_rev`, and the
322expected number of commits to be tested after `bisect_rev` is
323tested to `bisect_nr`, the expected number of commits to be
324tested if `bisect_rev` turns out to be good to `bisect_good`,
325the expected number of commits to be tested if `bisect_rev`
326turns out to be bad to `bisect_bad`, and the number of commits
327we are bisecting right now to `bisect_all`.
328
329--bisect-all::
330
331This outputs all the commit objects between the included and excluded
332commits, ordered by their distance to the included and excluded
333commits. The farthest from them is displayed first. (This is the only
334one displayed by `--bisect`.)
335
336This is useful because it makes it easy to choose a good commit to
337test when you want to avoid to test some of them for some reason (they
338may not compile for example).
339
340This option can be used along with `--bisect-vars`, in this case,
341after all the sorted commit objects, there will be the same text as if
342`--bisect-vars` had been used alone.
343endif::git-rev-list[]
344
345--
346
347Commit Ordering
348~~~~~~~~~~~~~~~
349
350By default, the commits are shown in reverse chronological order.
351
352--topo-order::
353
354This option makes them appear in topological order (i.e.
355descendant commits are shown before their parents).
356
357--date-order::
358
359This option is similar to '--topo-order' in the sense that no
360parent comes before all of its children, but otherwise things
361are still ordered in the commit timestamp order.
362
363--reverse::
364
365Output the commits in reverse order.
366Cannot be combined with '\--walk-reflogs'.
367
368Object Traversal
369~~~~~~~~~~~~~~~~
370
371These options are mostly targeted for packing of git repositories.
372
373--objects::
374
375Print the object IDs of any object referenced by the listed
376commits. '--objects foo ^bar' thus means "send me
377all object IDs which I need to download if I have the commit
378object 'bar', but not 'foo'".
379
380--objects-edge::
381
382Similar to '--objects', but also print the IDs of excluded
383commits prefixed with a "-" character. This is used by
384linkgit:git-pack-objects[1] to build "thin" pack, which records
385objects in deltified form based on objects contained in these
386excluded commits to reduce network traffic.
387
388--unpacked::
389
390Only useful with '--objects'; print the object IDs that are not
391in packs.
392
393--no-walk::
394
395Only show the given revs, but do not traverse their ancestors.
396
397--do-walk::
398
399Overrides a previous --no-walk.