diff options
author | Andrew M. Kuchling <amk@amk.ca> | 2008-04-05 02:47:07 (GMT) |
---|---|---|
committer | Andrew M. Kuchling <amk@amk.ca> | 2008-04-05 02:47:07 (GMT) |
commit | 1f2af8c6e4499c78e40268754e679ae9dff91a13 (patch) | |
tree | 612f13a372f5e71cf98796359158c41ce941ec0f /Doc/library/signal.rst | |
parent | 9ff4aea24cf82468bb89d3a1cb872a6dd9fd9cff (diff) | |
download | cpython-1f2af8c6e4499c78e40268754e679ae9dff91a13.zip cpython-1f2af8c6e4499c78e40268754e679ae9dff91a13.tar.gz cpython-1f2af8c6e4499c78e40268754e679ae9dff91a13.tar.bz2 |
Markup fix; explain what interval timers do; typo fix
Diffstat (limited to 'Doc/library/signal.rst')
-rw-r--r-- | Doc/library/signal.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 9274113..9843ff6 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -82,7 +82,7 @@ The variables defined in the :mod:`signal` module are: .. 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 @@ The :mod:`signal` module defines the following functions: :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 @@ The :mod:`signal` module defines the following functions: .. 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 |