diff options
| author | Vicent Martà <tanoku@gmail.com> | 2011-11-25 21:30:08 -0800 |
|---|---|---|
| committer | Vicent Martà <tanoku@gmail.com> | 2011-11-25 21:30:08 -0800 |
| commit | e42ea1f488ae50655f31b8f09413a543b0fab9b7 (patch) | |
| tree | 7697099dd809bb1e2e9fb28b4c1127853b5801ba /include/git2/refs.h | |
| parent | 2869f404fd1fb345bfe86471dbcfba85abaa9f10 (diff) | |
| parent | a5cd086dffbc07ad839f3a9c320dda6970594126 (diff) | |
| download | libgit2-e42ea1f488ae50655f31b8f09413a543b0fab9b7.tar.gz | |
Merge pull request #491 from schu/refs-cleanup
reference_rename() cleanup
Diffstat (limited to 'include/git2/refs.h')
| -rw-r--r-- | include/git2/refs.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h index 82c5d8881..32671aa66 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -183,6 +183,11 @@ GIT_EXTERN(int) git_reference_set_oid(git_reference *ref, const git_oid *id); * If the `force` flag is not enabled, and there's already * a reference with the given name, the renaming will fail. * + * IMPORTANT: + * The user needs to write a proper reflog entry if the + * reflog is enabled for the repository. We only rename + * the reflog if it exists. + * * @param ref The reference to rename * @param new_name The new name for the reference * @param force Overwrite an existing reference |