Clarify git-cherry documentation.
[git/git.git] / Documentation / git-cherry.txt
1 git-cherry(1)
2 =============
3
4 NAME
5 ----
6 git-cherry - Find commits not merged upstream
7
8 SYNOPSIS
9 --------
10 'git-cherry' [-v] <upstream> [<head>]
11
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
17 Every commit with a changeset that doesn't exist in the other branch
18 has its id (sha1) reported, prefixed by a symbol. Those existing only
19 in the <upstream> branch are prefixed with a minus (-) sign, and those
20 that only exist in the <head> branch are prefixed with a plus (+) symbol.
21
22 Because git-cherry compares the changeset rather than the commit id
23 (sha1), you can use git-cherry to find out if a commit you made locally
24 has been applied <upstream> under a different commit id. For example,
25 this will happen if you're feeding patches <upstream> via email rather
26 than pushing or pulling commits directly.
27
28
29 OPTIONS
30 -------
31 -v::
32 Verbose.
33
34 <upstream>::
35 Upstream branch to compare against.
36
37 <head>::
38 Working branch; defaults to HEAD.
39
40 Author
41 ------
42 Written by Junio C Hamano <junkio@cox.net>
43
44 Documentation
45 --------------
46 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
47
48 GIT
49 ---
50 Part of the gitlink:git[7] suite
51