git-tar-tree: no more void pointer arithmetic

[git.git] / Documentation / git-cherry.txt
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt

index 14d0bd5..893baaa 100644 (file)
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -3,26 +3,39 @@ git-cherry(1)
  
  NAME
  ----
-git-cherry - Some git command not yet documented.
-
+git-cherry - Find commits not merged upstream
  
  SYNOPSIS
  --------
-'git-cherry' [ --option ] <args>...
+'git-cherry' [-v] <upstream> [<head>]
  
  DESCRIPTION
  -----------
-Does something not yet documented.
+The changeset (or "diff") of each commit between the fork-point and <head>
+is compared against each commit between the fork-point and <upstream>.
+
+Every commit with a changeset that doesn't exist in the other branch
+has its id (sha1) reported, prefixed by a symbol.  Those existing only
+in the <upstream> branch are prefixed with a minus (-) sign, and those
+that only exist in the <head> branch are prefixed with a plus (+) symbol.
+
+Because git-cherry compares the changeset rather than the commit id
+(sha1), you can use git-cherry to find out if a commit you made locally
+has been applied <upstream> under a different commit id.  For example,
+this will happen if you're feeding patches <upstream> via email rather
+than pushing or pulling commits directly.
  
  
  OPTIONS
  -------
---option::
-       Some option not yet documented.
+-v::
+       Verbose.
  
-<args>...::
-       Some argument not yet documented.
+<upstream>::
+       Upstream branch to compare against.
  
+<head>::
+       Working branch; defaults to HEAD.
  
  Author
  ------
@@ -34,5 +47,5 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  
  GIT
  ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite