summaryrefslogtreecommitdiff
path: root/include/git2/object.h
diff options
context:
space:
mode:
authorMarc Pegon <pegon.marc@gmail.com>2011-05-28 21:24:25 +0200
committerVicent Marti <tanoku@gmail.com>2011-06-01 23:40:41 +0200
commitac2b94ad7658b53035b8518842348a083decd418 (patch)
tree19c5220d8493f697a4f09557ca4dfafb6cc12b36 /include/git2/object.h
parentdd453c4dbf9a1fa38530b1f51e079852736b8f66 (diff)
downloadlibgit2-ac2b94ad7658b53035b8518842348a083decd418.tar.gz
Added a GIT_OID_MINPREFIXLEN constant to define the minimum length allowed for oid prefixes (set to 4, like in git). Consequently updated some object lookup methods and their documentation.
Diffstat (limited to 'include/git2/object.h')
-rw-r--r--include/git2/object.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/object.h b/include/git2/object.h
index 4cb6af0ad..cadb942e0 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -65,9 +65,9 @@ GIT_EXTERN(int) git_object_lookup(git_object **object, git_repository *repo, con
* The object obtained will be so that its identifier
* matches the first 'len' hexadecimal characters
* (packets of 4 bits) of the given 'id'.
- * 'len' must be long enough to identify a unique
- * object matching the prefix; otherwise the method will
- * fail.
+ * 'len' must be at least GIT_OID_MINPREFIXLEN, and
+ * long enough to identify a unique object matching
+ * the prefix; otherwise the method will fail.
*
* The generated reference is owned by the repository and
* should be closed with the `git_object_close` method