NAME

git-cherry - Find commits yet to be applied to upstream

SYNOPSIS

  1. git cherry [-v] [<upstream> [<head> [<limit>]]]

DESCRIPTION

Determine whether there are commits in <head>..<upstream> that are equivalent to those in the range <limit>..<head>.

The equivalence test is based on the diff, after removing whitespace and line numbers. git-cherry therefore detects when commits have been “copied” by means of git-cherry-pick[1], git-am[1] or git-rebase[1].

Outputs the SHA1 of every commit in <limit>..<head>, prefixed with - for commits that have an equivalent in <upstream>, and + for commits that do not.

OPTIONS

-v

Show the commit subjects next to the SHA1s.

<upstream>

Upstream branch to search for equivalent commits. Defaults to the upstream branch of HEAD.

<head>

Working branch; defaults to HEAD.

<limit>

Do not report commits up to (and including) limit.

EXAMPLES

Patch workflows

git-cherry is frequently used in patch-based workflows (see gitworkflows[7]) to determine if a series of patches has been applied by the upstream maintainer. In such a workflow you might create and send a topic branch like this:

  1. $ git checkout -b topic origin/master
  2. # work and create some commits
  3. $ git format-patch origin/master
  4. $ git send-email ... 00*

Later, you can see whether your changes have been applied by saying (still on topic):

  1. $ git fetch  # update your notion of origin/master
  2. $ git cherry -v

Concrete example

In a situation where topic consisted of three commits, and the maintainer applied two of them, the situation might look like:

  1. $ git log --graph --oneline --decorate --boundary origin/master...topic
  2. * 7654321 (origin/master) upstream tip commit
  3. [... snip some other commits ...]
  4. * cccc111 cherry-pick of C
  5. * aaaa111 cherry-pick of A
  6. [... snip a lot more that has happened ...]
  7. | * cccc000 (topic) commit C
  8. | * bbbb000 commit B
  9. | * aaaa000 commit A
  10. |/
  11. o 1234567 branch point

In such cases, git-cherry shows a concise summary of what has yet to be applied:

  1. $ git cherry origin/master topic
  2. - cccc000... commit C
  3. + bbbb000... commit B
  4. - aaaa000... commit A

Here, we see that the commits A and C (marked with -) can be dropped from your topic branch when you rebase it on top of origin/master, while the commit B (marked with +) still needs to be kept so that it will be sent to be applied to origin/master.

Using a limit

The optional <limit> is useful in cases where your topic is based on other work that is not in upstream. Expanding on the previous example, this might look like:

  1. $ git log --graph --oneline --decorate --boundary origin/master...topic
  2. * 7654321 (origin/master) upstream tip commit
  3. [... snip some other commits ...]
  4. * cccc111 cherry-pick of C
  5. * aaaa111 cherry-pick of A
  6. [... snip a lot more that has happened ...]
  7. | * cccc000 (topic) commit C
  8. | * bbbb000 commit B
  9. | * aaaa000 commit A
  10. | * 0000fff (base) unpublished stuff F
  11. [... snip ...]
  12. | * 0000aaa unpublished stuff A
  13. |/
  14. o 1234567 merge-base between upstream and topic

By specifying base as the limit, you can avoid listing commits between base and topic:

  1. $ git cherry origin/master topic base
  2. - cccc000... commit C
  3. + bbbb000... commit B
  4. - aaaa000... commit A

SEE ALSO

git-patch-id[1]

GIT

Part of the git[1] suite