Merge remote-tracking branch 'rmoehn/cherry-pick-cleanup'

libgit2 · May 3, 2015 · e461198 · e461198
2 parents 8a196f6 + 654e4bf
commit e461198
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/docs/merge.rst b/docs/merge.rst
@@ -40,6 +40,10 @@ Cherrypick
 
 .. automethod:: pygit2.Repository.cherrypick
 
+Note that after a successful cherrypick you have to run
+:py:meth:`.Repository.state_cleanup` in order to get the repository out
+of cherrypicking mode.
+
 
 Lower-level methods
 ===================

diff --git a/docs/recipes/git-cherry-pick.rst b/docs/recipes/git-cherry-pick.rst
@@ -30,6 +30,8 @@ working copy and on-disk index.
                            cherry.message, tree_id, [basket.target])
         del basket # outdated, prevent from accidentally using it
 
+        repo.state_cleanup()
+
 
 ----------------------------------------------------------------------
 Cherry-picking a commit without a working copy