diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2014-08-16 12:42:46 +0200 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-08-16 12:42:46 +0200 |
| commit | c80c2c0670668d134eb1bbf849f6d0f963135634 (patch) | |
| tree | d6232870d4e5f02841f252c5369147a39795a86b | |
| parent | fa44a1699ccd70725b236868ef4be5cac8c36267 (diff) | |
| download | libgit2-cmn/doc-allocfmt.tar.gz | |
oid: explain why allocfmt is exposedcmn/doc-allocfmt
This should fix one part of #2493.
| -rw-r--r-- | include/git2/oid.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/oid.h b/include/git2/oid.h index 1cfd4e5e2..482e22e3d 100644 --- a/include/git2/oid.h +++ b/include/git2/oid.h @@ -118,6 +118,9 @@ GIT_EXTERN(void) git_oid_pathfmt(char *out, const git_oid *id); /** * Format a git_oid into a newly allocated c-string. * + * It is not possible for an external user to call the appropriate + * freeing function. It is part of the public API as a debug aid. + * * @param id the oid structure to format * @return the c-string; NULL if memory is exhausted. Caller must * deallocate the string with git__free(). |