commit d18d69f25a87d08b59de227ce6391f24bdfb49f1
author Lang Hames <lhames@gmail.com> Sat Sep 29 23:49:54 2018 +0000
committer Lang Hames <lhames@gmail.com> Sat Sep 29 23:49:54 2018 +0000
tree d40802f787da9e365531cadcce68a533c3c56f60
parent 6ca6a03c51b67cb94528a05e1efe502e2e61d9e4

Add a comment to clarify the contract for LLVMGetErrorMessage in the c-bindings
for Error.

llvm-svn: 343394

llvm/include/llvm-c/Error.h

diff --git a/llvm/include/llvm-c/Error.h b/llvm/include/llvm-c/Error.h
index 6a5ba87..71e8466 100644
--- a/llvm/include/llvm-c/Error.h
+++ b/llvm/include/llvm-c/Error.h
@@ -47,6 +47,8 @@
 /**
  * Returns the given string's error message. This operation consumes the error,
  * and the given LLVMErrorRef value is not usable once this call returns.
+ * The caller is responsible for disposing of the string by calling
+ * LLVMDisposeErrorMessage.
  */
 char *LLVMGetErrorMessage(LLVMErrorRef Err);