]> git.proxmox.com Git - libgit2.git/blobdiff - include/git2/refs.h
Update Copyright header
[libgit2.git] / include / git2 / refs.h
index 82c5d8881b2ad6f9b481e84f7bbf7877c3aabb88..5395ded4b2152153434b8de5df39f00129895b72 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2009-2011 the libgit2 contributors
+ * Copyright (C) 2009-2012 the libgit2 contributors
  *
  * This file is part of libgit2, distributed under the GNU GPL v2 with
  * a Linking Exception. For full terms see the included COPYING file.
@@ -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