caretx.c: Add bool warning comment

It is for this reason that this file exists.

diff --git a/caretx.c b/caretx.c
index 184c7d0..25ca195 100644 (file)
--- a/caretx.c
+++ b/caretx.c
@@ -38,6 +38,12 @@
 # include <mach-o/dyld.h>
 #endif
 
+/* Note: Functions in this file must not have bool parameters.  When
+   PERL_BOOL_AS_CHAR is #defined, mach-o/dyld.h overrides it in this file
+   by #including stdbool.h, so the function parameters here would conflict
+   with those in proto.h.
+*/
+
 void
 Perl_set_caret_X(pTHX) {
     dVAR;