File tree Expand file tree Collapse file tree 1 file changed +3
-2
lines changed
Expand file tree Collapse file tree 1 file changed +3
-2
lines changed Original file line number Diff line number Diff line change @@ -805,11 +805,12 @@ Object Protocol
805805.. c :function :: int PyUnstable_SetImmortal (PyObject *op)
806806
807807 Marks the object *op * :term: `immortal `. The argument should be uniquely referenced by
808- the calling thread.
808+ the calling thread. This is intended to be used for reducing reference counting contention
809+ in the :term: `free-threaded build ` for objects which are shared across threads.
809810
810811 This is a one-way process: objects can only be made immortal; they cannot be
811812 made mortal once again. Immortal objects do not participate in reference counting
812- and will never be garbage collected.
813+ and will never be garbage collected. If the object is GC-tracked, it is untracked.
813814
814815 This function is intended to be used soon after *op * is created, by the code that
815816 creates it, such as in the object's :c:member: `~PyTypeObject.tp_new ` slot.
You can’t perform that action at this time.
0 commit comments