]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - signal.c
sched: Introduce task notifications.
[paraslash.git] / signal.c
index aa63c8b5461a9627c021a514b83b7c8ee1067067..b2317c9b3a51fefca4c490681424a2f8709563b2 100644 (file)
--- a/signal.c
+++ b/signal.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004-2012 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -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.
+ * 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 signal pipe is
- * returned.
+ * \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)
 {