From: Victor Stinner <vstinner@python.org>
Date: Tue, 14 Jan 2025 15:31:13 +0000 (+0100)
Subject: gh-59705: Document OS thread name change (#128800)
X-Git-Tag: v3.14.0a5~426
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d786ac7f584f23c3206f4c86032bdabe83c17b51;p=thirdparty%2FPython%2Fcpython.git

gh-59705: Document OS thread name change (#128800)
---

diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst
index f183f3f535c4..00511df32e43 100644
--- a/Doc/library/threading.rst
+++ b/Doc/library/threading.rst
@@ -380,6 +380,13 @@ since it is impossible to detect the termination of alien threads.
       This method will raise a :exc:`RuntimeError` if called more than once
       on the same thread object.
 
+      If supported, set the operating system thread name to
+      :attr:`threading.Thread.name`. The name can be truncated depending on the
+      operating system thread name limits.
+
+      .. versionchanged:: 3.14
+         Set the operating system thread name.
+
    .. method:: run()
 
       Method representing the thread's activity.
@@ -443,9 +450,6 @@ since it is impossible to detect the termination of alien threads.
       running thread is renamed. (Setting the *name* attribute of a
       different thread only updates the Python Thread object.)
 
-      .. versionchanged:: 3.14
-         Set the operating system thread name.
-
    .. method:: getName()
                setName()
 
diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
index ac203b208f4a..9f7ef101e564 100644
--- a/Doc/whatsnew/3.14.rst
+++ b/Doc/whatsnew/3.14.rst
@@ -645,6 +645,13 @@ sys.monitoring
 * Two new events are added: :monitoring-event:`BRANCH_LEFT` and
   :monitoring-event:`BRANCH_RIGHT`. The ``BRANCH`` event is deprecated.
 
+threading
+---------
+
+* :meth:`threading.Thread.start` now sets the operating system thread name
+  to :attr:`threading.Thread.name`.
+  (Contributed by Victor Stinner in :gh:`59705`.)
+
 tkinter
 -------