summaryrefslogtreecommitdiff
path: root/Documentation/git-cherry.txt
diff options
context:
space:
mode:
authorRene Scharfe <rene.scharfe@lsrfire.ath.cx>2006-10-26 23:32:41 +0200
committerJunio C Hamano <junkio@cox.net>2006-10-26 18:53:18 -0700
commita8ebdb90f9e7017aa47c7824c91dfb0dd231ac85 (patch)
tree1b80465f3e51fc2eee56fa5c496443c39e7c98cf /Documentation/git-cherry.txt
parentac1a1f9927b01df6c50a1e29d92c6e79e2daadff (diff)
downloadgit-a8ebdb90f9e7017aa47c7824c91dfb0dd231ac85.tar.gz
git-cherry: document limit and add diagram
This patch adds the diagram from the long usage string of git-cherry to its documentation, and documents the third option. I changed some of the + to - in order to save the reader from wondering where they might fit into the picture. Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-cherry.txt')
-rw-r--r--Documentation/git-cherry.txt19
1 files changed, 17 insertions, 2 deletions
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index e1bf8ee255..27b67b81a5 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -7,7 +7,7 @@ git-cherry - Find commits not merged upstream
SYNOPSIS
--------
-'git-cherry' [-v] <upstream> [<head>]
+'git-cherry' [-v] <upstream> [<head>] [<limit>]
DESCRIPTION
-----------
@@ -18,7 +18,22 @@ Every commit that doesn't exist in the <upstream> branch
has its id (sha1) reported, prefixed by a symbol. The ones that have
equivalent change already
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.
+that only exist in the <head> branch are prefixed with a plus (+) symbol:
+
+ __*__*__*__*__> <upstream>
+ /
+ fork-point
+ \__+__+__-__+__+__-__+__> <head>
+
+
+If a <limit> has been given then the commits along the <head> branch up
+to and including <limit> are not reported:
+
+ __*__*__*__*__> <upstream>
+ /
+ fork-point
+ \__*__*__<limit>__-__+__> <head>
+
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