Merge branch 'jn/notes-doc' into maint
[git/jnareb-git/bp-gitweb.git] / Documentation / git-cherry.txt
blobfed115acd01a63801a647ae870357d4c2d59ea44
1 git-cherry(1)
2 =============
4 NAME
5 ----
6 git-cherry - Find commits not merged upstream
8 SYNOPSIS
9 --------
10 'git cherry' [-v] [<upstream> [<head> [<limit>]]]
12 DESCRIPTION
13 -----------
14 The changeset (or "diff") of each commit between the fork-point and <head>
15 is compared against each commit between the fork-point and <upstream>.
16 The commits are compared with their 'patch id', obtained from
17 the 'git patch-id' program.
19 Every commit that doesn't exist in the <upstream> branch
20 has its id (sha1) reported, prefixed by a symbol.  The ones that have
21 equivalent change already
22 in the <upstream> branch are prefixed with a minus (-) sign, and those
23 that only exist in the <head> branch are prefixed with a plus (+) symbol:
25                __*__*__*__*__> <upstream>
26               /
27     fork-point
28               \__+__+__-__+__+__-__+__> <head>
31 If a <limit> has been given then the commits along the <head> branch up
32 to and including <limit> are not reported:
34                __*__*__*__*__> <upstream>
35               /
36     fork-point
37               \__*__*__<limit>__-__+__> <head>
40 Because 'git cherry' compares the changeset rather than the commit id
41 (sha1), you can use 'git cherry' to find out if a commit you made locally
42 has been applied <upstream> under a different commit id.  For example,
43 this will happen if you're feeding patches <upstream> via email rather
44 than pushing or pulling commits directly.
47 OPTIONS
48 -------
49 -v::
50         Verbose.
52 <upstream>::
53         Upstream branch to compare against.
54         Defaults to the first tracked remote branch, if available.
56 <head>::
57         Working branch; defaults to HEAD.
59 <limit>::
60         Do not report commits up to (and including) limit.
62 SEE ALSO
63 --------
64 linkgit:git-patch-id[1]
66 Author
67 ------
68 Written by Junio C Hamano <gitster@pobox.com>
70 Documentation
71 --------------
72 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
74 GIT
75 ---
76 Part of the linkgit:git[1] suite