summaryrefslogtreecommitdiffstats
path: root/llvm/include/llvm-c
diff options
context:
space:
mode:
authorLang Hames <lhames@gmail.com>2018-09-29 23:49:54 +0000
committerLang Hames <lhames@gmail.com>2018-09-29 23:49:54 +0000
commitd18d69f25a87d08b59de227ce6391f24bdfb49f1 (patch)
treed40802f787da9e365531cadcce68a533c3c56f60 /llvm/include/llvm-c
parent6ca6a03c51b67cb94528a05e1efe502e2e61d9e4 (diff)
downloadbcm5719-llvm-d18d69f25a87d08b59de227ce6391f24bdfb49f1.tar.gz
bcm5719-llvm-d18d69f25a87d08b59de227ce6391f24bdfb49f1.zip
Add a comment to clarify the contract for LLVMGetErrorMessage in the c-bindings
for Error. llvm-svn: 343394
Diffstat (limited to 'llvm/include/llvm-c')
-rw-r--r--llvm/include/llvm-c/Error.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/llvm/include/llvm-c/Error.h b/llvm/include/llvm-c/Error.h
index 6a5ba877eb7..71e84661222 100644
--- 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);
OpenPOWER on IntegriCloud