Introducing contrib/git-svn.
[gitweb.git] / Documentation / git-rev-list.txt
index f386a3a79bd1752b051de7c1e07d549bfa432de7..1c6146c7643ef273888b76def0891b8a7ad51c98 100644 (file)
@@ -1,6 +1,5 @@
 git-rev-list(1)
 ===============
-v0.1, May 2005
 
 NAME
 ----
@@ -9,7 +8,20 @@ git-rev-list - Lists commit objects in reverse chronological order
 
 SYNOPSIS
 --------
-'git-rev-list' [ *--max-count*=number ] [ *--max-age*=timestamp ] [ *--min-age*=timestamp ] [ *--bisect* ] [ *--pretty* ] [ *--objects* ] [ *--merge-order* [ *--show-breaks* ] ] <commit> [ <commit> ...] [ ^<commit> ...]
+[verse]
+'git-rev-list' [ \--max-count=number ]
+            [ \--max-age=timestamp ]
+            [ \--min-age=timestamp ]
+            [ \--sparse ]
+            [ \--no-merges ]
+            [ \--remove-empty ]
+            [ \--all ]
+            [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] ]
+            [ \--parents ]
+            [ \--objects [ \--unpacked ] ]
+            [ \--pretty | \--header ]
+            [ \--bisect ]
+            <commit>... [ \-- <paths>... ]
 
 DESCRIPTION
 -----------
@@ -17,22 +29,34 @@ Lists commit objects in reverse chronological order starting at the
 given commit(s), taking ancestry relationship into account.  This is
 useful to produce human-readable log output.
 
-Commits which are stated with a preceding '^' cause listing to stop at
-that point. Their parents are implied. "git-rev-list foo bar ^baz" thus
+Commits which are stated with a preceding '{caret}' cause listing to stop at
+that point. Their parents are implied. "git-rev-list foo bar {caret}baz" thus
 means "list all the commits which are included in 'foo' and 'bar', but
 not in 'baz'".
 
+A special notation <commit1>..<commit2> can be used as a
+short-hand for {caret}<commit1> <commit2>.
+
+
 OPTIONS
 -------
 --pretty::
        Print the contents of the commit changesets in human-readable form.
 
+--header::
+       Print the contents of the commit in raw-format; each
+       record is separated with a NUL character.
+
 --objects::
        Print the object IDs of any object referenced by the listed commits.
        'git-rev-list --objects foo ^bar' thus means "send me all object IDs
        which I need to download if I have the commit object 'bar', but
        not 'foo'".
 
+--unpacked::
+       Only useful with `--objects`; print the object IDs that
+       are not in packs.
+
 --bisect::
        Limit output to the one commit object which is roughly halfway
        between the included and excluded commits. Thus, if 'git-rev-list
@@ -43,6 +67,33 @@ OPTIONS
        repeatedly generate and test new 'midpoint's until the commit chain
        is of length one.
 
+--max-count::
+       Limit the number of commits output.
+
+--max-age=timestamp, --min-age=timestamp::
+       Limit the commits output to specified time range.
+
+--sparse::
+       When optional paths are given, the command outputs only
+       the commits that changes at least one of them, and also
+       ignores merges that do not touch the given paths.  This
+       flag makes the command output all eligible commits
+       (still subject to count and age limitation), but apply
+       merge simplification nevertheless.
+
+--remove-empty::
+       Stop when a given path disappears from the tree.
+
+--all::
+       Pretend as if all the refs in `$GIT_DIR/refs/` are
+       listed on the command line as <commit>.
+
+--topo-order::
+       By default, the commits are shown in reverse
+       chronological order.  This option makes them appear in
+       topological order (i.e. descendant commits are shown
+       before their parents).
+
 --merge-order::
        When specified the commit history is decomposed into a unique
        sequence of minimal, non-linear epochs and maximal, linear epochs.
@@ -83,9 +134,10 @@ the marked commit in the list.
 +
 Commits marked with (^) are not parents of the immediately preceding commit.
 These "breaks" represent necessary discontinuities implied by trying to
-represent an arbtirary DAG in a linear form.
+represent an arbitrary DAG in a linear form.
 +
-*--show-breaks* is only valid if *--merge-order* is also specified.
+`--show-breaks` is only valid if `--merge-order` is also specified.
+
 
 Author
 ------