From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sun, 27 Nov 2022 18:05:59 +0000 (-0800)
Subject: gh-91340: Document multiprocessing.set_start_method force parameter (GH-32339)
X-Git-Tag: v3.11.1~37
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=366adc7c832554454841fe7472c90f3ed9bf1f7d;p=thirdparty%2FPython%2Fcpython.git

gh-91340: Document multiprocessing.set_start_method force parameter (GH-32339)


GH-91340

https://bugs.python.org/issue47184
(cherry picked from commit dfc2732a57e3ea6603d62f769d4f9c80be726fa4)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
Automerge-Triggered-By: GH:kumaraditya303
---

diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index 551608478067..b5ceeb796f8f 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -1089,10 +1089,14 @@ Miscellaneous
    .. versionchanged:: 3.11
       Accepts a :term:`path-like object`.
 
-.. function:: set_start_method(method)
+.. function:: set_start_method(method, force=False)
 
    Set the method which should be used to start child processes.
-   *method* can be ``'fork'``, ``'spawn'`` or ``'forkserver'``.
+   The *method* argument can be ``'fork'``, ``'spawn'`` or ``'forkserver'``.
+   Raises :exc:`RuntimeError` if the start method has already been set and *force*
+   is not ``True``.  If *method* is ``None`` and *force* is ``True`` then the start
+   method is set to ``None``.  If *method* is ``None`` and *force* is ``False``
+   then the context is set to the default context.
 
    Note that this should be called at most once, and it should be
    protected inside the ``if __name__ == '__main__'`` clause of the