Improve documentation.

diff --git a/ChangeLog b/ChangeLog
index 20d30e03ef112dc27241d3496a8b169f77036665..e79b2aec1428de9bab7aa718fb2296b947f0ff90 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2008-07-20  Bruno Haible  <bruno@clisp.org>
+
+       * lib/c-stack.h (c_stack_action): Add documentation.
+       * lib/c-stack.c (c_stack_action): Remove incomplete documentation.
+
 2008-07-20  Bruno Haible  <bruno@clisp.org>
 
        * modules/canonicalize-lgpl (License): Relicense under LGPLv2+.

diff --git a/lib/c-stack.c b/lib/c-stack.c
index c81fbfa7827b61808f5c6b083b6a951f4bef8fbf..c46c23136111701b7f77cb9609bfeded145475be 100644 (file)
--- a/lib/c-stack.c
+++ b/lib/c-stack.c
@@ -189,21 +189,6 @@ overflow_handler (int emergency,
   die ((!emergency || segv_handler_missing) ? 0 : SIGSEGV);
 }
 
-/* Set up ACTION so that it is invoked on C stack overflow.  Return -1
-   (setting errno) if this cannot be done.
-
-   When ACTION is called, it is passed an argument equal to SIGSEGV
-   for a segmentation violation that does not appear related to stack
-   overflow, and is passed zero otherwise.  On many platforms it is
-   hard to tell; when in doubt, zero is passed.
-
-   A null ACTION acts like an action that does nothing.
-
-   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.  */
-
 int
 c_stack_action (void (*action) (int))
 {
@@ -298,21 +283,6 @@ segv_handler (int signo, siginfo_t *info,
 }
 # endif
 
-/* Set up ACTION so that it is invoked on C stack overflow.  Return -1
-   (setting errno) if this cannot be done.
-
-   When ACTION is called, it is passed an argument equal to SIGSEGV
-   for a segmentation violation that does not appear related to stack
-   overflow, and is passed zero otherwise.  On many platforms it is
-   hard to tell; when in doubt, zero is passed.
-
-   A null ACTION acts like an action that does nothing.
-
-   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.  */
-
 int
 c_stack_action (void (*action) (int))
 {

diff --git a/lib/c-stack.h b/lib/c-stack.h
index 5f80457398e3041dac8f64aee067cd642e6b9a32..8c06541fd62c2239be345b2dfc97ae176d99dbd1 100644 (file)
--- a/lib/c-stack.h
+++ b/lib/c-stack.h
@@ -1,6 +1,6 @@
 /* Stack overflow handling.
 
-   Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2004, 2008 Free Software Foundation, Inc.
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -15,4 +15,27 @@
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
-int c_stack_action (void (*) (int));
+
+/* Set up ACTION so that it is invoked on C stack overflow and on other,
+   stack-unrelated, segmentation violation.
+   Return -1 (setting errno) if this cannot be done.
+
+   When a stack overflow or segmentation violation occurs:
+   1) ACTION is called.  It is passed an argument equal to
+        - 0, for a stack overflow,
+        - SIGSEGV, for a segmentation violation that does not appear related
+          to stack overflow.
+      On many platforms the two cases are hard to distinguish; when in doubt,
+      zero is passed.
+   2) If ACTION returns, a message is written to standard error, and the
+      program is terminated: in the case of stack overflow, with exit code
+      exit_failure (see "exitfail.h"), otherwise through a signal SIGSEGV.
+
+   A null ACTION acts like an action that does nothing.
+
+   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.  */
+
+extern int c_stack_action (void (* /*action*/) (int));