diff options
Diffstat (limited to 'include/git2/object.h')
| -rw-r--r-- | include/git2/object.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/git2/object.h b/include/git2/object.h index 7417ea913..9b13d824e 100644 --- a/include/git2/object.h +++ b/include/git2/object.h @@ -107,6 +107,11 @@ GIT_EXTERN(const git_oid *) git_object_id(const git_object *obj); /** * Get a short abbreviated OID string for the object * + * This starts at the "core.abbrev" length (default 7 characters) and + * iteratively extends to a longer string if that length is ambiguous. + * The result will be unambiguous (at least until new objects are added to + * the repository). + * * @param out Buffer to write string into * @param obj The object to get an ID for * @return 0 on success, <0 for error |