Skip to content

Commit 35e65db

Browse files
authored
docs: update upgrade guide
1 parent 6157c42 commit 35e65db

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/upgrade.rst

+16
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@ to a new version. But it goes into more detail. This includes things like
88
deprecated APIs and their replacements, build system changes, general code
99
modernization and other useful information.
1010

11+
.. _upgrade-guide-2.10:
12+
13+
v2.10
14+
=====
15+
16+
The current scoped GIL implementation doesn't support nested access. In pybind11
17+
In 2.10.1, a configuration option ``PYBIND11_SIMPLE_GIL`` was added, defaulting
18+
to OFF; the simpler GIL implemntation supports nested access, but does not
19+
support dissociation (the ``true`` parameter of ``gil_scope_release``). In
20+
pybind11 2.11, we plan to change the default to ON. If you need the old
21+
behavior, please set ``PYBIND11_SIMPLE_GIL`` to OFF. We plan to have an example
22+
for manually supporting dissociation.
23+
24+
There may be an unconfirmed ABI breakage between 2.9 and 2.10. We plan to bump
25+
the internals number in 2.11.
26+
1127
.. _upgrade-guide-2.9:
1228

1329
v2.9

0 commit comments

Comments
 (0)