vendor/libgit2/src/refs.h in rugged-0.27.1 vs vendor/libgit2/src/refs.h in rugged-0.27.2
- old
+ new
@@ -114,9 +114,13 @@
* This function will read in the file at `path`. If it is a
* symref, it will return a new unresolved symbolic reference
* with the given name pointing to the reference pointed to by
* the file. If it is not a symbolic reference, it will return
* the resolved reference.
+ *
+ * Note that because the refdb is not involved for symbolic references, they
+ * won't be owned, hence you should either not make the returned reference
+ * 'externally visible', or perform the lookup before returning it to the user.
*/
int git_reference__read_head(
git_reference **out,
git_repository *repo,
const char *path);