From c80c2c0670668d134eb1bbf849f6d0f963135634 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Sat, 16 Aug 2014 12:42:46 +0200 Subject: oid: explain why allocfmt is exposed This should fix one part of #2493. --- include/git2/oid.h | 3 +++ 1 file changed, 3 insertions(+) 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(). -- cgit v1.2.1