diff --git a/docs/merge.rst b/docs/merge.rst index b1c688b..0e1dd4d 100644 --- 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 index 6026a23..310e236 100644 --- 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