Add comments.

diff --git a/ChangeLog b/ChangeLog
index d37da3b..f6ed815 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2008-12-06  Bruno Haible  <bruno@clisp.org>
 
+       * lib/c-stack.h (c_stack_action): Clarify possible side effects.
+       Suggested by Eric Blake.
+
+2008-12-06  Bruno Haible  <bruno@clisp.org>
+
        Fix a c-stack test failure on MacOS X.
        * m4/c-stack.m4 (AC_SYS_XSI_STACK_OVERFLOW_HEURISTIC): Require
        AC_CANONICAL_HOST. Define FAULT_YIELDS_SIGBUS. If set, install a signal

diff --git a/lib/c-stack.h b/lib/c-stack.h
index 8c06541..e1e0a6e 100644 (file)
--- a/lib/c-stack.h
+++ b/lib/c-stack.h
@@ -36,6 +36,9 @@
    ACTION must be async-signal-safe.  ACTION together with its callees
    must not require more than SIGSTKSZ bytes of stack space.  Also,
    ACTION should not call longjmp, because this implementation does
-   not guarantee that it is safe to return to the original stack.  */
+   not guarantee that it is safe to return to the original stack.
+
+   This function may install a handler for the SIGSEGV signal or for the SIGBUS
+   signal or exercise other system dependent exception handling APIs.  */
 
 extern int c_stack_action (void (* /*action*/) (int));