From: Andre Noll <maan@systemlinux.org>
Date: Tue, 14 Aug 2012 11:09:43 +0000 (+0200)
Subject: signal: Improve documentation of para_signal_init().
X-Git-Tag: v0.4.12~37
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=8c24d4e777f21a8773adfd028af26b967d1880ec

signal: Improve documentation of para_signal_init().

para_signal_init() does not install any signal handlers, so this part of the
documentation is incorrect. The patch fixes this flaw, mentions which end of
the signal pipe is returned to the caller and improves the wording a bit.
---

diff --git a/signal.c b/signal.c
index 0b7b47fa..b2317c9b 100644
--- a/signal.c
+++ b/signal.c
@@ -22,15 +22,15 @@ static int signal_pipe[2];
  * during the application's startup part, followed by subsequent calls
  * to para_install_sighandler() for each signal that should be caught.
  *
- * para_signal_init() installs a generic signal handler which is used for all
- * signals simultaneously. When a signal arrives, this generic signal handler
- * writes the corresponding signal number to the signal pipe so that the
- * application can test for pending signals simply by checking the signal pipe
- * for reading, e.g. by using the select(2) system call.
- *
- * \return This function either succeeds or calls exit(2) to terminate
- * the current process. On success, the file descriptor of the signal pipe is
- * returned.
+ * A generic signal handler is used for all signals simultaneously. When a
+ * signal arrives, the signal handler writes the number of the signal received
+ * to one end of the signal pipe. The application can test for pending signals
+ * by checking if the file descriptor of the other end of the signal pipe is
+ * ready for reading, see select(2).
+ *
+ * \return This function either succeeds or calls exit(2) to terminate the
+ * current process. On success, the file descriptor of the read end of the
+ * signal pipe is returned.
  */
 int para_signal_init(void)
 {