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