check_type: fix incorrect documentation.
[ccan] / ccan / compiler / _info
index 06645b1d8c9d8e26ea2d554553351f53795e8bd7..9f3945397386cc7ff058c1529143671dbf259be5 100644 (file)
@@ -6,20 +6,22 @@
  * compiler - macros for common compiler extensions
  *
  * Abstracts away some compiler hints.  Currently these include:
- * - COLD_ATTRIBUTE
+ * - COLD
  *     For functions not called in fast paths (aka. cold functions)
- * - PRINTF_ATTRIBUTE
+ * - PRINTF_FMT
  *     For functions which take printf-style parameters.
- * - IDEMPOTENT_ATTRIBUTE
+ * - CONST_FUNCTION
  *     For functions which return the same value for same parameters.
- * - NEEDED_ATTRIBUTE
+ * - NEEDED
  *     For functions and variables which must be emitted even if unused.
- * - UNNEEDED_ATTRIBUTE
+ * - UNNEEDED
  *     For functions and variables which need not be emitted if unused.
- * - IS_COMPILE_CONSTANT
+ * - UNUSED
+ *     For parameters which are not used.
+ * - IS_COMPILE_CONSTANT()
  *     For using different tradeoffs for compiletime vs runtime evaluation.
  *
- * Licence: LGPL (3 or any later version)
+ * License: Public Domain
  * Author: Rusty Russell <rusty@rustcorp.com.au>
  *
  * Example:
@@ -29,7 +31,7 @@
  *
  *     // Example of a (slow-path) logging function.
  *     static int log_threshold = 2;
- *     static void COLD_ATTRIBUTE PRINTF_ATTRIBUTE(2,3)
+ *     static void COLD PRINTF_FMT(2,3)
  *             logger(int level, const char *fmt, ...)
  *     {
  *             va_list ap;