bpo-30511: Add note on thread safety to shutil.make_archive() (#26933)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>

diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index d5080da15bba41b3c6d2eb996b9871bd38fcd55a..11c6707492167299e666628d49765187b1a4fb3e 100644 (file)
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -595,6 +595,10 @@ provided.  They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
 
    .. audit-event:: shutil.make_archive base_name,format,root_dir,base_dir shutil.make_archive
 
+   .. note::
+
+      This function is not thread-safe.
+
    .. versionchanged:: 3.8
       The modern pax (POSIX.1-2001) format is now used instead of
       the legacy GNU format for archives created with ``format="tar"``.

diff --git a/Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst b/Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst
new file mode 100644 (file)
index 0000000..a358fb9
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-07-20-21-03-18.bpo-30511.eMFkRi.rst
@@ -0,0 +1,2 @@
+Clarify that :func:`shutil.make_archive` is not thread-safe due to
+reliance on changing the current working directory.