Skip to content

Commit

Permalink
docs: update upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
henryiii authored and Ralf W. Grosse-Kunstleve committed Oct 26, 2022
1 parent 5ec2283 commit 1e8644e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@ to a new version. But it goes into more detail. This includes things like
deprecated APIs and their replacements, build system changes, general code
modernization and other useful information.

.. _upgrade-guide-2.10:

v2.10
=====

The current scoped GIL implementation doesn't support nested access. In pybind11
In 2.10.1, a configuration option ``PYBIND11_SIMPLE_GIL`` was added, defaulting
to OFF; the simpler GIL implemntation supports nested access, but does not
support dissociation (the ``true`` parameter of ``gil_scope_release``). In
pybind11 2.11, we plan to change the default to ON. If you need the old
behavior, please set ``PYBIND11_SIMPLE_GIL`` to OFF. We plan to have an example
for manually supporting dissociation.

There may be an unconfirmed ABI breakage between 2.9 and 2.10. We plan to bump
the internals number in 2.11.

.. _upgrade-guide-2.9:

v2.9
Expand Down

0 comments on commit 1e8644e

Please sign in to comment.