diff options
Diffstat (limited to 'Documentation/git-cherry.txt')
| -rw-r--r-- | Documentation/git-cherry.txt | 55 |
1 files changed, 41 insertions, 14 deletions
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt index 9a5e37186f..f6c19c734d 100644 --- a/Documentation/git-cherry.txt +++ b/Documentation/git-cherry.txt @@ -7,15 +7,43 @@ git-cherry - Find commits not merged upstream SYNOPSIS -------- -'git-cherry' [-v] <upstream> [<head>] +[verse] +'git cherry' [-v] [<upstream> [<head> [<limit>]]] DESCRIPTION ----------- -Each commit between the fork-point and <head> is examined, and compared against -the change each commit between the fork-point and <upstream> introduces. -Commits already included in upstream are prefixed with '-' (meaning "drop from -my local pull"), while commits missing from upstream are prefixed with '+' -(meaning "add to the updated upstream"). +The changeset (or "diff") of each commit between the fork-point and <head> +is compared against each commit between the fork-point and <upstream>. +The commits are compared with their 'patch id', obtained from +the 'git patch-id' program. + +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: + + __*__*__*__*__> <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 +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 ------- @@ -24,19 +52,18 @@ OPTIONS <upstream>:: Upstream branch to compare against. + Defaults to the first tracked remote branch, if available. <head>:: Working branch; defaults to HEAD. -Author ------- -Written by Junio C Hamano <junkio@cox.net> +<limit>:: + Do not report commits up to (and including) limit. -Documentation --------------- -Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. +SEE ALSO +-------- +linkgit:git-patch-id[1] GIT --- -Part of the gitlink:git[7] suite - +Part of the linkgit:git[1] suite |