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

for Error.

llvm-svn: 343394

diff --git a/llvm/include/llvm-c/Error.h b/llvm/include/llvm-c/Error.h
index 6a5ba87..71e8466 100644 (file)
--- a/llvm/include/llvm-c/Error.h
+++ b/llvm/include/llvm-c/Error.h
@@ -47,6 +47,8 @@ void LLVMConsumeError(LLVMErrorRef Err);
 /**
  * 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);