Merge branch 'maint'

[git.git] / Documentation / git-rev-list.txt

diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index c742117595cd8ae5ab371a7ba21513a419af7996..ab90a22f11bbc92b4397135dac062cbfd7474bae 100644 (file)
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -21,12 +21,17 @@ SYNOPSIS
             [ \--stdin ]
             [ \--topo-order ]
             [ \--parents ]
             [ \--stdin ]
             [ \--topo-order ]
             [ \--parents ]

+            [ \--left-right ]
+            [ \--cherry-pick ]

             [ \--encoding[=<encoding>] ]
             [ \--(author|committer|grep)=<pattern> ]
             [ \--encoding[=<encoding>] ]
             [ \--(author|committer|grep)=<pattern> ]

+            [ \--date={local|relative|default} ]

             [ [\--objects | \--objects-edge] [ \--unpacked ] ]
             [ \--pretty | \--header ]
             [ \--bisect ]
             [ [\--objects | \--objects-edge] [ \--unpacked ] ]
             [ \--pretty | \--header ]
             [ \--bisect ]

+            [ \--bisect-vars ]

             [ \--merge ]
             [ \--merge ]

+            [ \--reverse ]

             [ \--walk-reflogs ]
             <commit>... [ \-- <paths>... ]
 
             [ \--walk-reflogs ]
             <commit>... [ \-- <paths>... ]
 


@@ -82,13 +87,24 @@ Using these options, gitlink:git-rev-list[1] will act similar to the
 more specialized family of commit log tools: gitlink:git-log[1],
 gitlink:git-show[1], and gitlink:git-whatchanged[1]
 
 more specialized family of commit log tools: gitlink:git-log[1],
 gitlink:git-show[1], and gitlink:git-whatchanged[1]
 

-include::pretty-formats.txt[]
+include::pretty-options.txt[]

 
 --relative-date::
 
 
 --relative-date::
 

-       Show dates relative to the current time, e.g. "2 hours ago".
+       Synonym for `--date=relative`.
+
+--date={relative,local,default}::
+

        Only takes effect for dates shown in human-readable format, such
        as when using "--pretty".
        Only takes effect for dates shown in human-readable format, such
        as when using "--pretty".

++
+`--date=relative` shows dates relative to the current time,
+e.g. "2 hours ago".
++
+`--date=local` shows timestamps in user's local timezone.
++
+`--date=default` shows timestamps in the original timezone
+(either committer's or author's).

 
 --header::
 
 
 --header::
 


@@ -99,6 +115,36 @@ include::pretty-formats.txt[]
 
        Print the parents of the commit.
 
 
        Print the parents of the commit.
 

+--left-right::
+
+       Mark which side of a symmetric diff a commit is reachable from.
+       Commits from the left side are prefixed with `<` and those from
+       the right with `>`.  If combined with `--boundary`, those
+       commits are prefixed with `-`.
++
+For example, if you have this topology:
++
+-----------------------------------------------------------------------
+             y---b---b  branch B
+            / \ /
+           /   .
+          /   / \
+         o---x---a---a  branch A
+-----------------------------------------------------------------------
++
+you would get an output line this:
++
+-----------------------------------------------------------------------
+       $ git rev-list --left-right --boundary --pretty=oneline A...B
+
+       >bbbbbbb... 3rd on b
+       >bbbbbbb... 2nd on b
+       <aaaaaaa... 3rd on a
+       <aaaaaaa... 2nd on a
+       -yyyyyyy... 1st on b
+       -xxxxxxx... 1st on a
+-----------------------------------------------------------------------
+

 Diff Formatting
 ~~~~~~~~~~~~~~~
 
 Diff Formatting
 ~~~~~~~~~~~~~~~
 


@@ -191,6 +237,20 @@ limiting may be applied.
        In addition to the '<commit>' listed on the command
        line, read them from the standard input.
 
        In addition to the '<commit>' listed on the command
        line, read them from the standard input.
 

+--cherry-pick::
+
+       Omit any commit that introduces the same change as
+       another commit on the "other side" when the set of
+       commits are limited with symmetric difference.
++
+For example, if you have two branches, `A` and `B`, a usual way
+to list all commits on only one side of them is with
+`--left-right`, like the example above in the description of
+that option.  It however shows the commits that were cherry-picked
+from the other branch (for example, "3rd on b" may be cherry-picked
+from branch A).  With this option, such pairs of commits are
+excluded from the output.
+

 -g, --walk-reflogs::
 
        Instead of walking the commit ancestry chain, walk
 -g, --walk-reflogs::
 
        Instead of walking the commit ancestry chain, walk


@@ -248,6 +308,18 @@ introduces a regression is thus reduced to a binary search: repeatedly
 generate and test new 'midpoint's until the commit chain is of length
 one.
 
 generate and test new 'midpoint's until the commit chain is of length
 one.
 

+--bisect-vars::
+
+This calculates the same as `--bisect`, but outputs text ready
+to be eval'ed by the shell. These lines will assign the name of
+the midpoint revision to the variable `bisect_rev`, and the
+expected number of commits to be tested after `bisect_rev` is
+tested to `bisect_nr`, the expected number of commits to be
+tested if `bisect_rev` turns out to be good to `bisect_good`,
+the expected number of commits to be tested if `bisect_rev`
+turns out to be bad to `bisect_bad`, and the number of commits
+we are bisecting right now to `bisect_all`.
+

 --
 
 Commit Ordering
 --
 
 Commit Ordering


@@ -266,6 +338,10 @@ By default, the commits are shown in reverse chronological order.
        parent comes before all of its children, but otherwise things
        are still ordered in the commit timestamp order.
 
        parent comes before all of its children, but otherwise things
        are still ordered in the commit timestamp order.
 

+--reverse::
+
+       Output the commits in reverse order.
+

 Object Traversal
 ~~~~~~~~~~~~~~~~
 
 Object Traversal
 ~~~~~~~~~~~~~~~~
 


@@ -291,6 +367,10 @@ These options are mostly targeted for packing of git repositories.
        Only useful with '--objects'; print the object IDs that are not
        in packs.
 
        Only useful with '--objects'; print the object IDs that are not
        in packs.
 

+
+include::pretty-formats.txt[]
+
+

 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>