From 4bd2a508fbb100052b42a5aa35d829514d69a0fb Mon Sep 17 00:00:00 2001 From: Johan Abildskov Date: Mon, 20 Aug 2018 13:51:28 +0200 Subject: Update giterr_last API documentation to reflect real behaviour --- include/git2/errors.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'include/git2') diff --git a/include/git2/errors.h b/include/git2/errors.h index 00fbed157..5ae58bd64 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -109,7 +109,12 @@ typedef enum { /** * Return the last `git_error` object that was generated for the - * current thread or NULL if no error has occurred. + * current thread. + * + * The default behaviour of this function is to return NULL if no previous error has occurred. + * However, libgit2's error strings are not cleared aggressively, so a prior + * (unrelated) error may be returned. This can avoided by only calling + * this function if the prior call to a libgit2 API returned an error. * * @return A git_error object. */ -- cgit v1.2.1