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>
This commit is contained in:
Rene Scharfe 2006-10-26 23:32:41 +02:00 committed by Junio C Hamano
parent ac1a1f9927
commit a8ebdb90f9

View File

@ -7,7 +7,7 @@ git-cherry - Find commits not merged upstream
SYNOPSIS SYNOPSIS
-------- --------
'git-cherry' [-v] <upstream> [<head>] 'git-cherry' [-v] <upstream> [<head>] [<limit>]
DESCRIPTION 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 has its id (sha1) reported, prefixed by a symbol. The ones that have
equivalent change already equivalent change already
in the <upstream> branch are prefixed with a minus (-) sign, and those 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 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 (sha1), you can use git-cherry to find out if a commit you made locally