]> granicus.if.org Git - python/commitdiff
Issue #9524: Document that two CTRL* signals are meant for use only
authorBrian Curtin <brian.curtin@gmail.com>
Thu, 5 Aug 2010 18:56:00 +0000 (18:56 +0000)
committerBrian Curtin <brian.curtin@gmail.com>
Thu, 5 Aug 2010 18:56:00 +0000 (18:56 +0000)
with os.kill.

Doc/library/signal.rst
Misc/NEWS

index 7b40e8e67dab1f00407ac369bbadbb8632a85072..a3d562b4ffe78f3c697d418e25113006a3bcc6bc 100644 (file)
@@ -76,7 +76,9 @@ The variables defined in the :mod:`signal` module are:
 
 .. data:: CTRL_C_EVENT
 
-   The signal corresponding to the CTRL+C keystroke event.
+   The signal corresponding to the CTRL+C keystroke event. This signal can
+   only be used with :func:`os.kill`.
+
    Availability: Windows.
 
    .. versionadded:: 3.2
@@ -84,7 +86,9 @@ The variables defined in the :mod:`signal` module are:
 
 .. data:: CTRL_BREAK_EVENT
 
-   The signal corresponding to the CTRL+BREAK keystroke event.
+   The signal corresponding to the CTRL+BREAK keystroke event. This signal can
+   only be used with :func:`os.kill`.
+
    Availability: Windows.
 
    .. versionadded:: 3.2
index fe93e4eda6ed80a2083b5a3fc6393c2f34c97def..abcb9d8ead71e76ad168cd60a4407f42f2ae34d0 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -1849,6 +1849,9 @@ Build
 Documentation
 ------------
 
+- Issue #9524: Document that two CTRL* signals are meant for use only
+  with os.kill.
+
 - Issue #9255: Document that the 'test' package is meant for internal Python use
   only.