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>
Rene Scharfe committed
Oct 26, 2006 at 23:32 UTC
a8ebdb90f9e7017aa47c7824c91dfb0dd231ac85
1 file changed
+17
-2
Documentation/git-cherry.txt
+17
-2
@@ -7,7 +7,7 @@ git-cherry - Find commits not merged upstream
7
8
SYNOPSIS
9
--------
10
-'git-cherry' [-v] <upstream> [<head>]
10
+'git-cherry' [-v] <upstream> [<head>] [<limit>]
11
12
DESCRIPTION
13
-----------
@@ -18,7 +18,22 @@ Every commit that doesn't exist in the <upstream> branch
18
has its id (sha1) reported, prefixed by a symbol. The ones that have
19
equivalent change already
20
in the <upstream> branch are prefixed with a minus (-) sign, and those
21
-that only exist in the <head> branch are prefixed with a plus (+) symbol.
21
+that only exist in the <head> branch are prefixed with a plus (+) symbol:
22
+
23
+ __*__*__*__*__> <upstream>
24
+ /
25
+ fork-point
26
+ \__+__+__-__+__+__-__+__> <head>
27
+
28
+
29
+If a <limit> has been given then the commits along the <head> branch up
30
+to and including <limit> are not reported:
31
+
32
+ __*__*__*__*__> <upstream>
33
+ /
34
+ fork-point
35
+ \__*__*__<limit>__-__+__> <head>
36
+
37
38
Because git-cherry compares the changeset rather than the commit id
39
(sha1), you can use git-cherry to find out if a commit you made locally