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 8575fb50cd4e78c000248ad9e2b952a73183b8f3..e369e2b134268b37ca2815c34a92c6f541db79db 100644 (file)
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -901,8 +901,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:: get_all_start_methods()