Commit 3602b57328819d381d46e7e5f37ccea3e9479f01

Johan Abildskov 2018-08-20T10:08:30

Document giterr_last() use only after error. #4772

1
2
3
4
5
6
7
8
9
10
11
12
13
diff --git a/docs/error-handling.md b/docs/error-handling.md
index 719244d..d769bca 100644
--- a/docs/error-handling.md
+++ b/docs/error-handling.md
@@ -117,6 +117,8 @@ The public error API
   the last error.  This may return NULL if no error has occurred.
   Otherwise this should return a `git_error` object indicating the class
   of error and the error message that was generated by the library.
+  Do not use this method unless you received an error, it will 
+  lead to undefined behaviour.
 
   The last error is stored in thread-local storage when libgit2 is
   compiled with thread support, so you do not have to worry about another