diff options
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 |