Add a comment about ATTRIBUTE_UNUSED to avoid further confusion over when to

use it.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@116920 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Support/Compiler.h b/include/llvm/Support/Compiler.h
index 9ff78173c96b43868e2475caeca4206578431f0c..014e801282855329101647d233bca89c314cea8a 100644 (file)
--- a/include/llvm/Support/Compiler.h
+++ b/include/llvm/Support/Compiler.h
@@ -31,6 +31,14 @@
 #define ATTRIBUTE_USED
 #endif
 
+// Some compilers warn about unused functions. When a function is sometimes
+// used or not depending on build settings (e.g. a function only called from
+// within "assert"), this attribute can be used to suppress such warnings.
+//
+// However, it shouldn't be used for unused *variables*, as those have a much
+// more portable solution:
+//   (void)unused_var_name;
+// Prefer cast-to-void wherever it is sufficient.
 #if (__GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 #define ATTRIBUTE_UNUSED __attribute__((__unused__))
 #else