[Python-checkins] r62159 - python/trunk/Doc/library/signal.rst

[andrew.kuchling]

Author: andrew.kuchling
Date: Sat Apr  5 04:47:07 2008
New Revision: 62159

Modified:
   python/trunk/Doc/library/signal.rst
Log:
Markup fix; explain what interval timers do; typo fix

Modified: python/trunk/Doc/library/signal.rst
==============================================================================
--- python/trunk/Doc/library/signal.rst	(original)
+++ python/trunk/Doc/library/signal.rst	Sat Apr  5 04:47:07 2008
@@ -82,7 +82,7 @@
 
 .. data:: ITIMER_REAL    
 
-   Decrements interval timer in real time, and delivers SIGALRM upon expiration.
+   Decrements interval timer in real time, and delivers :const:`SIGALRM` upon expiration.
 
 
 .. data:: ITIMER_VIRTUAL 
@@ -149,6 +149,12 @@
    :func:`alarm`) and after that every *interval* seconds. The interval
    timer specified by *which* can be cleared by setting seconds to zero.
 
+   When an interval timer fires, a signal is sent to the process.
+   The signal sent is dependent on the timer being used; 
+   :const:`signal.ITIMER_REAL` will deliver :const:`SIGALRM`, 
+   :const:`signal.ITIMER_VIRTUAL` sends :const:`SIGVTALRM`,
+   and :const:`signal.ITIMER_PROF` will deliver :const:`SIGPROF`.
+
    The old values are returned as a tuple: (delay, interval).
 
    Attempting to pass an invalid interval timer will cause a 
@@ -159,7 +165,7 @@
 
 .. function:: getitimer(which)
 
-   Returns current value of a given interval timer especified by *which*.
+   Returns current value of a given interval timer specified by *which*.
 
    .. versionadded:: 2.6