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