Refine HIDE_POINTER documentation for the case of the leak-finding mode

* include/gc.h (GC_HIDE_POINTER, GC_REVEAL_POINTER): Refine comment
(warn about usage in the leak-finding mode).

diff --git a/include/gc.h b/include/gc.h
index b46ebab255aef879b0bf1890f3a9570b6d54b45c..1080dae328ab0641103031cea671677025201f54 100644 (file)
--- a/include/gc.h
+++ b/include/gc.h
@@ -1369,6 +1369,7 @@ GC_API void GC_CALL GC_abort_on_oom(void);
 /* that finalization code will arrange for hidden pointers to   */
 /* disappear.  Otherwise objects can be accessed after they     */
 /* have been collected.                                         */
+/* Should not be used in the leak-finding mode.                 */
 /* Note that putting pointers in atomic objects or in           */
 /* non-pointer slots of "typed" objects is equivalent to        */
 /* disguising them in this way, and may have other advantages.  */