gh-108223: Document --disable-gil flag in configure #108236
Conversation
colesbury
added
docs
Doc/using/configure.rst
Outdated
| .. cmdoption:: --disable-gil | ||
|
|
||
| Enables experimental support for running Python without the global | ||
| interpreter lock (GIL). |
There was a problem hiding this comment.
You should add a reference to the related PEP:
See :pep:`703` "Making the Global Interpreter Lock Optional in CPython".
Co-authored-by: Victor Stinner <[email protected]>
Doc/using/configure.rst
Outdated
| Enables experimental support for running Python without the | ||
| :term:`global interpreter lock` (GIL). |
There was a problem hiding this comment.
Should we add a warning admonition emphasising that this is experimental, in development, etc -- mainly to preempt a random twitter recommendation that "No GIL has now been implemented! Rebuild your Python today with --disable-gil..."
Perhaps a fear that won't materialise, though!
A
There was a problem hiding this comment.
I'm okay with adding whatever text you think is helpful. I expect to revisit and update this later in the development cycle based on what's actually integrated.
There was a problem hiding this comment.
Thanks Sam! Victor's simpler change I think is better for now--we don't really advertise building from source to end-users anyway, so I on reflection I think we don't need a high level of warning here.
A
|
considering how much "nothing" this flag is currently doing, vs how much hype it could lead to -- perhaps it should be left undocumented for now? otherwise, i'd add something like "experimental and under active development - does NOT yet provide actual GIL-less capabilities - intended for use only by contributors actively working on implementing PEP-703 and buildbots" |
I disagree. I prefer to provide accurate documentation, because of the hype. |
|
This is always room for enhancement, but IMO that's a good start for the documentation :-) Maybe a reference documentation should be added later for any question related to NOGIL. For now, the doc points to the complete PEP. |
|
There's a new commit after the PR has been approved. @vstinner: please review the changes made to this pull request. |
Adds an entry in the configure documentation for the
--disable-gilflag.📚 Documentation preview 📚: https://cpython-previews--108236.org.readthedocs.build/