Refine GC_stackbottom description in gc.h

* include/gc.h (GC_stackbottom): Improve comment (add note for
new client code).

diff --git a/include/gc.h b/include/gc.h
index 8df0239cab2721bb119f8ded04f67827e76a64da..f460a634e37322043dc1af81d126f38a5c5ff146 100644 (file)
--- a/include/gc.h
+++ b/include/gc.h
@@ -286,7 +286,10 @@ GC_API char *GC_stackbottom;    /* Cool end of user stack.              */
                                 /* automatically.                       */
                                 /* For multi-threaded code, this is the */
                                 /* cold end of the stack for the        */
-                                /* primordial thread.                   */
+                                /* primordial thread.  Portable clients */
+                                /* should use GC_get_stack_base(),      */
+                                /* GC_call_with_gc_active() and         */
+                                /* GC_register_my_thread() instead.     */
 
 GC_API int GC_dont_precollect;  /* Don't collect as part of GC          */
                                 /* initialization.  Should be set only  */