From: Brian Curtin <brian.curtin@gmail.com>
Date: Thu, 5 Aug 2010 18:56:00 +0000 (+0000)
Subject: Issue #9524: Document that two CTRL* signals are meant for use only
X-Git-Tag: v3.2a2~459
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f045d775fd900a4cc4da027e37a50ab984d18ce7;p=thirdparty%2FPython%2Fcpython.git

Issue #9524: Document that two CTRL* signals are meant for use only
with os.kill.
---

diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index 7b40e8e67dab..a3d562b4ffe7 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -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
diff --git a/Misc/NEWS b/Misc/NEWS
index fe93e4eda6ed..abcb9d8ead71 100644
--- 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.