diff options
| author | Ruoyu Zhong <zhongruoyu@outlook.com> | 2024-10-13 00:53:28 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-13 00:53:28 (GMT) |
| commit | a8fa4ad9e9f7aa0cba8b23af2c583d17bb1d1847 (patch) | |
| tree | 60c84023b406219d547c658a466a2cd9e7a1394f /Doc | |
| parent | 330c527299a5380f39c658bfa9321706cabc445d (diff) | |
| download | cpython-a8fa4ad9e9f7aa0cba8b23af2c583d17bb1d1847.zip cpython-a8fa4ad9e9f7aa0cba8b23af2c583d17bb1d1847.tar.gz cpython-a8fa4ad9e9f7aa0cba8b23af2c583d17bb1d1847.tar.bz2 | |
Doc: Fix suggested usage of `-X gil=0` in the glossary (#125366)
Currently, the "global interpreter lock" entry in the glossary mentions
that `-X gil 0` can be used to disable the GIL [1]. However, this is
invalid; the correct usage should be `-X gil=0`.
$ python -X gil 0 -c 'print("Hello, world")'
Fatal Python error: config_read_gil: PYTHON_GIL / -X gil must be "0" or "1"
Python runtime state: preinitialized
$ python -X gil=0 -c 'print("Hello, world")'
Hello, world
[1]: https://docs.python.org/3/using/cmdline.html#cmdoption-X
Signed-off-by: Ruoyu Zhong <zhongruoyu@outlook.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/glossary.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 1d40773..f67f3ec 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -617,7 +617,7 @@ Glossary As of Python 3.13, the GIL can be disabled using the :option:`--disable-gil` build configuration. After building Python with this option, code must be - run with :option:`-X gil 0 <-X>` or after setting the :envvar:`PYTHON_GIL=0 <PYTHON_GIL>` + run with :option:`-X gil=0 <-X>` or after setting the :envvar:`PYTHON_GIL=0 <PYTHON_GIL>` environment variable. This feature enables improved performance for multi-threaded applications and makes it easier to use multi-core CPUs efficiently. For more details, see :pep:`703`. |