Commit e069478edc1711e92c25eb26b82370f37775142b

Li Xuanji 2013-05-21T21:35:58

define "long name" in git_reference_name_to_id

1
2
3
4
5
6
7
8
9
10
11
12
13
diff --git a/include/git2/refs.h b/include/git2/refs.h
index 754bda7..510000c 100644
--- a/include/git2/refs.h
+++ b/include/git2/refs.h
@@ -48,7 +48,7 @@ GIT_EXTERN(int) git_reference_lookup(git_reference **out, git_repository *repo, 
  *
  * @param out Pointer to oid to be filled in
  * @param repo The repository in which to look up the reference
- * @param name The long name for the reference
+ * @param name The long name for the reference (e.g. HEAD, refs/heads/master, refs/tags/v0.1.0, ...)
  * @return 0 on success, ENOTFOUND, EINVALIDSPEC or an error code.
  */
 GIT_EXTERN(int) git_reference_name_to_id(