diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2021-09-26 17:58:08 -0400 |
|---|---|---|
| committer | Edward Thomson <ethomson@edwardthomson.com> | 2021-09-26 18:02:07 -0400 |
| commit | 0bd132ab829f41971355537ecc4f9d24f953ccec (patch) | |
| tree | f2077ec3f7e71dec8a7a26f04c6af481d28e5500 /include/git2/deprecated.h | |
| parent | 136901086ecfdd2b5cc106782310355a9c0b1a9a (diff) | |
| download | libgit2-ethomson/oidarray_dispose.tar.gz | |
oidarray: introduce `git_oidarray_dispose`ethomson/oidarray_dispose
Since users are disposing the _contents_ of the oidarray, not freeing
the oidarray itself, the proper cleanup function is
`git_oidarray_dispose`. Deprecate `git_oidarray_free`.
Diffstat (limited to 'include/git2/deprecated.h')
| -rw-r--r-- | include/git2/deprecated.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h index 6b268eb79..37b9fa0e2 100644 --- a/include/git2/deprecated.h +++ b/include/git2/deprecated.h @@ -779,6 +779,30 @@ GIT_EXTERN(int) git_oid_iszero(const git_oid *id); /**@}*/ +/** @name Deprecated OID Array Functions + * + * These types are retained for backward compatibility. The newer + * versions of these values should be preferred in all new code. + * + * There is no plan to remove these backward compatibility values at + * this time. + */ +/**@{*/ + +/** + * Free the memory referred to by the git_oidarray. This is an alias of + * `git_oidarray_dispose` and is preserved for backward compatibility. + * + * This function is deprecated, but there is no plan to remove this + * function at this time. + * + * @deprecated Use git_oidarray_dispose + * @see git_oidarray_dispose + */ +GIT_EXTERN(void) git_oidarray_free(git_oidarray *array); + +/**@}*/ + /** @name Deprecated Transfer Progress Types * * These types are retained for backward compatibility. The newer |