Issue #5501: Clarify that invoking freeze_support() on non-Windows platforms has...

Patch by Davin Potts and Camilla Montonen.

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 2c765f551c1b5ceb590314d95d0f412a20988e8c..cab480610567f7a9f5d88a0ff5c82b53ca21b082 100644 (file)
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -751,8 +751,10 @@ Miscellaneous
    If the ``freeze_support()`` line is omitted then trying to run the frozen
    executable will raise :exc:`RuntimeError`.
 
-   If the module is being run normally by the Python interpreter then
-   :func:`freeze_support` has no effect.
+   Calling ``freeze_support()`` has no effect when invoked on any operating
+   system other than Windows.  In addition, if the module is being run
+   normally by the Python interpreter on Windows (the program has not been
+   frozen), then ``freeze_support()`` has no effect.
 
 .. function:: set_executable()