mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 18:29:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

gh-93103: Enhance PyConfig.parser_debug documentation (#93186)

Browse source 
Document that -d option and PYTHONDEBUG env var require a debug
build of Python. Also mention them in the debug build documentation.
This commit is contained in:
Victor Stinner 2022-05-24 23:23:01 +02:00 • committed by GitHub
parent fbd11f3edd
commit c7667a2d35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

3
Doc/c-api/init_config.rst
View file

@ -986,6 +986,9 @@ PyConfig
Incremented by the :option:`-d` command line option. Set to the Incremented by the :option:`-d` command line option. Set to the
:envvar:`PYTHONDEBUG` environment variable value. :envvar:`PYTHONDEBUG` environment variable value.
Need a :ref:`debug build of Python <debug-build>` (the ``Py_DEBUG`` macro
must be defined).
Default: ``0``. Default: ``0``.
.. c:member:: int pathconfig_warnings .. c:member:: int pathconfig_warnings

10
Doc/using/cmdline.rst
View file

@ -248,8 +248,11 @@ Miscellaneous options
.. cmdoption:: -d .. cmdoption:: -d
Turn on parser debugging output (for expert only, depending on compilation Turn on parser debugging output (for expert only).
options). See also :envvar:`PYTHONDEBUG`. See also the :envvar:`PYTHONDEBUG` environment variable.
This option requires a :ref:`debug build of Python <debug-build>`, otherwise
it's ignored.
.. cmdoption:: -E .. cmdoption:: -E
@ -660,6 +663,9 @@ conflict.
:option:`-d` option. If set to an integer, it is equivalent to specifying :option:`-d` option. If set to an integer, it is equivalent to specifying
:option:`-d` multiple times. :option:`-d` multiple times.
This environment variable requires a :ref:`debug build of Python
<debug-build>`, otherwise it's ignored.
.. envvar:: PYTHONINSPECT .. envvar:: PYTHONINSPECT

2
Doc/using/configure.rst
View file

@ -278,6 +278,8 @@ Effects of a debug build:
* Add ``d`` to :data:`sys.abiflags`. * Add ``d`` to :data:`sys.abiflags`.
* Add :func:`sys.gettotalrefcount` function. * Add :func:`sys.gettotalrefcount` function.
* Add :option:`-X showrefcount <-X>` command line option. * Add :option:`-X showrefcount <-X>` command line option.
* Add :option:`-d` command line option and :envvar:`PYTHONDEBUG` environment
variable to debug the parser.
* Add support for the ``__lltrace__`` variable: enable low-level tracing in the * Add support for the ``__lltrace__`` variable: enable low-level tracing in the
bytecode evaluation loop if the variable is defined. bytecode evaluation loop if the variable is defined.
* Install :ref:`debug hooks on memory allocators <default-memory-allocators>` * Install :ref:`debug hooks on memory allocators <default-memory-allocators>`