t7701-repack-unpack-unreachable.sh: check timestamp of unpacked objects
[git/jnareb-git.git] / Documentation / rev-list-options.txt
blob37dd1d61ea36d7afb1e1b16cc46bee0d357ad1c8
1 Commit Formatting
2 ~~~~~~~~~~~~~~~~~
4 ifdef::git-rev-list[]
5 Using these options, linkgit:git-rev-list[1] will act similar to the
6 more specialized family of commit log tools: linkgit:git-log[1],
7 linkgit:git-show[1], and linkgit:git-whatchanged[1]
8 endif::git-rev-list[]
10 include::pretty-options.txt[]
12 --relative-date::
14         Synonym for `--date=relative`.
16 --date={relative,local,default,iso,rfc,short}::
18         Only takes effect for dates shown in human-readable format, such
19         as when using "--pretty". `log.date` config variable sets a default
20         value for log command's --date option.
22 `--date=relative` shows dates relative to the current time,
23 e.g. "2 hours ago".
25 `--date=local` shows timestamps in user's local timezone.
27 `--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format.
29 `--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
30 format, often found in E-mail messages.
32 `--date=short` shows only date but not time, in `YYYY-MM-DD` format.
34 `--date=default` shows timestamps in the original timezone
35 (either committer's or author's).
37 ifdef::git-rev-list[]
38 --header::
40         Print the contents of the commit in raw-format; each record is
41         separated with a NUL character.
42 endif::git-rev-list[]
44 --parents::
46         Print the parents of the commit.
48 ifdef::git-rev-list[]
49 --timestamp::
50         Print the raw commit timestamp.
51 endif::git-rev-list[]
53 --left-right::
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 `-`.
60 For example, if you have this topology:
62 -----------------------------------------------------------------------
63              y---b---b  branch B
64             / \ /
65            /   .
66           /   / \
67          o---x---a---a  branch A
68 -----------------------------------------------------------------------
70 you would get an output line this:
72 -----------------------------------------------------------------------
73         $ git rev-list --left-right --boundary --pretty=oneline A...B
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 -----------------------------------------------------------------------
83 --graph::
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.
90 This implies the '--topo-order' option by default, but the
91 '--date-order' option may also be specified.
93 Diff Formatting
94 ~~~~~~~~~~~~~~~
96 Below are listed options that control the formatting of diff output.
97 Some of them are specific to linkgit:git-rev-list[1], however other diff
98 options may be given. See linkgit:git-diff-files[1] for more options.
100 -c::
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.
108 --cc::
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.
115 -r::
117         Show recursive diffs.
119 -t::
121         Show the tree objects in the diff output. This implies '-r'.
123 Commit Limiting
124 ~~~~~~~~~~~~~~~
126 Besides specifying a range of commits that should be listed using the
127 special notations explained in the description, additional commit
128 limiting may be applied.
132 -n 'number'::
133 --max-count='number'::
135         Limit the number of commits output.
137 --skip='number'::
139         Skip 'number' commits before starting to show the commit output.
141 --since='date'::
142 --after='date'::
144         Show commits more recent than a specific date.
146 --until='date'::
147 --before='date'::
149         Show commits older than a specific date.
151 ifdef::git-rev-list[]
152 --max-age='timestamp'::
153 --min-age='timestamp'::
155         Limit the commits output to specified time range.
156 endif::git-rev-list[]
158 --author='pattern'::
159 --committer='pattern'::
161         Limit the commits output to ones with author/committer
162         header lines that match the specified pattern (regular expression).
164 --grep='pattern'::
166         Limit the commits output to ones with log message that
167         matches the specified pattern (regular expression).
169 -i::
170 --regexp-ignore-case::
172         Match the regexp limiting patterns without regard to letters case.
174 -E::
175 --extended-regexp::
177         Consider the limiting patterns to be extended regular expressions
178         instead of the default basic regular expressions.
180 -F::
181 --fixed-strings::
183         Consider the limiting patterns to be fixed strings (don't interpret
184         pattern as a regular expression).
186 --remove-empty::
188         Stop when a given path disappears from the tree.
190 --full-history::
192         Show also parts of history irrelevant to current state of a given
193         path. This turns off history simplification, which removed merges
194         which didn't change anything at all at some child. It will still actually
195         simplify away merges that didn't change anything at all into either
196         child.
198 --no-merges::
200         Do not print commits with more than one parent.
202 --first-parent::
203         Follow only the first parent commit upon seeing a merge
204         commit.  This option can give a better overview when
205         viewing the evolution of a particular topic branch,
206         because merges into a topic branch tend to be only about
207         adjusting to updated upstream from time to time, and
208         this option allows you to ignore the individual commits
209         brought in to your history by such a merge.
211 --not::
213         Reverses the meaning of the '{caret}' prefix (or lack thereof)
214         for all following revision specifiers, up to the next '--not'.
216 --all::
218         Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the
219         command line as '<commit>'.
221 ifdef::git-rev-list[]
222 --stdin::
224         In addition to the '<commit>' listed on the command
225         line, read them from the standard input.
227 --quiet::
229         Don't print anything to standard output.  This form
230         is primarily meant to allow the caller to
231         test the exit status to see if a range of objects is fully
232         connected (or not).  It is faster than redirecting stdout
233         to /dev/null as the output does not have to be formatted.
234 endif::git-rev-list[]
236 --cherry-pick::
238         Omit any commit that introduces the same change as
239         another commit on the "other side" when the set of
240         commits are limited with symmetric difference.
242 For example, if you have two branches, `A` and `B`, a usual way
243 to list all commits on only one side of them is with
244 `--left-right`, like the example above in the description of
245 that option.  It however shows the commits that were cherry-picked
246 from the other branch (for example, "3rd on b" may be cherry-picked
247 from branch A).  With this option, such pairs of commits are
248 excluded from the output.
250 -g::
251 --walk-reflogs::
253         Instead of walking the commit ancestry chain, walk
254         reflog entries from the most recent one to older ones.
255         When this option is used you cannot specify commits to
256         exclude (that is, '{caret}commit', 'commit1..commit2',
257         nor 'commit1...commit2' notations cannot be used).
259 With '\--pretty' format other than oneline (for obvious reasons),
260 this causes the output to have two extra lines of information
261 taken from the reflog.  By default, 'commit@\{Nth}' notation is
262 used in the output.  When the starting commit is specified as
263 'commit@{now}', output also uses 'commit@\{timestamp}' notation
264 instead.  Under '\--pretty=oneline', the commit message is
265 prefixed with this information on the same line.
267 Cannot be combined with '\--reverse'.
268 See also linkgit:git-reflog[1].
270 --merge::
272         After a failed merge, show refs that touch files having a
273         conflict and don't exist on all heads to merge.
275 --boundary::
277         Output uninteresting commits at the boundary, which are usually
278         not shown.
280 --dense::
281 --sparse::
283 When optional paths are given, the default behaviour ('--dense') is to
284 only output commits that changes at least one of them, and also ignore
285 merges that do not touch the given paths.
287 Use the '--sparse' flag to makes the command output all eligible commits
288 (still subject to count and age limitation), but apply merge
289 simplification nevertheless.
291 ifdef::git-rev-list[]
292 --bisect::
294 Limit output to the one commit object which is roughly halfway between
295 the included and excluded commits. Thus, if
297 -----------------------------------------------------------------------
298         $ git-rev-list --bisect foo ^bar ^baz
299 -----------------------------------------------------------------------
301 outputs 'midpoint', the output of the two commands
303 -----------------------------------------------------------------------
304         $ git-rev-list foo ^midpoint
305         $ git-rev-list midpoint ^bar ^baz
306 -----------------------------------------------------------------------
308 would be of roughly the same length.  Finding the change which
309 introduces a regression is thus reduced to a binary search: repeatedly
310 generate and test new 'midpoint's until the commit chain is of length
311 one.
313 --bisect-vars::
315 This calculates the same as `--bisect`, but outputs text ready
316 to be eval'ed by the shell. These lines will assign the name of
317 the midpoint revision to the variable `bisect_rev`, and the
318 expected number of commits to be tested after `bisect_rev` is
319 tested to `bisect_nr`, the expected number of commits to be
320 tested if `bisect_rev` turns out to be good to `bisect_good`,
321 the expected number of commits to be tested if `bisect_rev`
322 turns out to be bad to `bisect_bad`, and the number of commits
323 we are bisecting right now to `bisect_all`.
325 --bisect-all::
327 This outputs all the commit objects between the included and excluded
328 commits, ordered by their distance to the included and excluded
329 commits. The farthest from them is displayed first. (This is the only
330 one displayed by `--bisect`.)
332 This is useful because it makes it easy to choose a good commit to
333 test when you want to avoid to test some of them for some reason (they
334 may not compile for example).
336 This option can be used along with `--bisect-vars`, in this case,
337 after all the sorted commit objects, there will be the same text as if
338 `--bisect-vars` had been used alone.
339 endif::git-rev-list[]
343 Commit Ordering
344 ~~~~~~~~~~~~~~~
346 By default, the commits are shown in reverse chronological order.
348 --topo-order::
350         This option makes them appear in topological order (i.e.
351         descendant commits are shown before their parents).
353 --date-order::
355         This option is similar to '--topo-order' in the sense that no
356         parent comes before all of its children, but otherwise things
357         are still ordered in the commit timestamp order.
359 --reverse::
361         Output the commits in reverse order.
362         Cannot be combined with '\--walk-reflogs'.
364 Object Traversal
365 ~~~~~~~~~~~~~~~~
367 These options are mostly targeted for packing of git repositories.
369 --objects::
371         Print the object IDs of any object referenced by the listed
372         commits.  '--objects foo ^bar' thus means "send me
373         all object IDs which I need to download if I have the commit
374         object 'bar', but not 'foo'".
376 --objects-edge::
378         Similar to '--objects', but also print the IDs of excluded
379         commits prefixed with a "-" character.  This is used by
380         linkgit:git-pack-objects[1] to build "thin" pack, which records
381         objects in deltified form based on objects contained in these
382         excluded commits to reduce network traffic.
384 --unpacked::
386         Only useful with '--objects'; print the object IDs that are not
387         in packs.
389 --no-walk::
391         Only show the given revs, but do not traverse their ancestors.
393 --do-walk::
395         Overrides a previous --no-walk.