Skip to content

gh-109054: Document configure variables #109224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Doc/library/hashlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,8 @@ include a `salt <https://en.wikipedia.org/wiki/Salt_%28cryptography%29>`_.
.. versionadded:: 3.6


.. _hashlib-blake2:

BLAKE2
------

Expand Down
149 changes: 149 additions & 0 deletions Doc/using/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,136 @@ General Options

.. versionadded:: 3.13

.. cmdoption:: PKG_CONFIG

Path to ``pkg-config`` utility.

.. cmdoption:: PKG_CONFIG_LIBDIR
.. cmdoption:: PKG_CONFIG_PATH

``pkg-config`` options.


C compiler options
------------------

.. cmdoption:: CC

C compiler command.

.. cmdoption:: CFLAGS

C compiler flags.

.. cmdoption:: CPP

C preprocessor command.

.. cmdoption:: CPPFLAGS

C preprocessor flags, e.g. :samp:`-I{include_dir}`.


Linker options
--------------

.. cmdoption:: LDFLAGS

Linker flags, e.g. :samp:`-L{library_directory}`.

.. cmdoption:: LIBS

Libraries to pass to the linker, e.g. :samp:`-l{library}`.

.. cmdoption:: MACHDEP

Name for machine-dependent library files.


Options for third-party dependencies
------------------------------------

.. versionadded:: 3.11

.. cmdoption:: BZIP2_CFLAGS
.. cmdoption:: BZIP2_LIBS

C compiler and linker flags to link Python to ``libbz2``, used by :mod:`bz2`
module, overriding ``pkg-config``.

.. cmdoption:: CURSES_CFLAGS
.. cmdoption:: CURSES_LIBS

C compiler and linker flags for ``libncurses`` or ``libncursesw``, used by
:mod:`curses` module, overriding ``pkg-config``.

.. cmdoption:: GDBM_CFLAGS
.. cmdoption:: GDBM_LIBS

C compiler and linker flags for ``gdbm``.

.. cmdoption:: LIBB2_CFLAGS
.. cmdoption:: LIBB2_LIBS

C compiler and linker flags for ``libb2`` (:ref:`BLAKE2 <hashlib-blake2>`),
used by :mod:`hashlib` module, overriding ``pkg-config``.

.. cmdoption:: LIBEDIT_CFLAGS
.. cmdoption:: LIBEDIT_LIBS

C compiler and linker flags for ``libedit``, used by :mod:`readline` module,
overriding ``pkg-config``.

.. cmdoption:: LIBFFI_CFLAGS
.. cmdoption:: LIBFFI_LIBS

C compiler and linker flags for ``libffi``, used by :mod:`ctypes` module,
overriding ``pkg-config``.

.. cmdoption:: LIBLZMA_CFLAGS
.. cmdoption:: LIBLZMA_LIBS

C compiler and linker flags for ``liblzma``, used by :mod:`lzma` module,
overriding ``pkg-config``.

.. cmdoption:: LIBREADLINE_CFLAGS
.. cmdoption:: LIBREADLINE_LIBS

C compiler and linker flags for ``libreadline``, used by :mod:`readline`
module, overriding ``pkg-config``.

.. cmdoption:: LIBSQLITE3_CFLAGS
.. cmdoption:: LIBSQLITE3_LIBS

C compiler and linker flags for ``libsqlite3``, used by :mod:`sqlite3`
module, overriding ``pkg-config``.

.. cmdoption:: LIBUUID_CFLAGS
.. cmdoption:: LIBUUID_LIBS

C compiler and linker flags for ``libuuid``, used by :mod:`uuid` module,
overriding ``pkg-config``.

.. cmdoption:: PANEL_CFLAGS
.. cmdoption:: PANEL_LIBS

C compiler and Linker flags for PANEL, overriding ``pkg-config``.

C compiler and linker flags for ``libpanel`` or ``libpanelw``, used by
:mod:`curses.panel` module, overriding ``pkg-config``.

.. cmdoption:: TCLTK_CFLAGS
.. cmdoption:: TCLTK_LIBS

C compiler and linker flags for TCLTK, overriding ``pkg-config``.

.. cmdoption:: ZLIB_CFLAGS
.. cmdoption:: ZLIB_LIBS

C compiler and linker flags for ``libzlib``, used by :mod:`gzip` module,
overriding ``pkg-config``.


WebAssembly Options
-------------------

Expand Down Expand Up @@ -428,6 +558,19 @@ also be used to improve performance.

.. versionadded:: 3.12

.. cmdoption:: BOLT_APPLY_FLAGS

Arguments to ``llvm-bolt`` when creating a `BOLT optimized binary
<https://github.com/facebookarchive/BOLT>`_.

.. versionadded:: 3.12

.. cmdoption:: BOLT_INSTRUMENT_FLAGS

Arguments to ``llvm-bolt`` when instrumenting binaries.

.. versionadded:: 3.12

.. cmdoption:: --with-computed-gotos

Enable computed gotos in evaluation loop (enabled by default on supported
Expand Down Expand Up @@ -775,6 +918,12 @@ the version of the cross compiled host Python.
ac_cv_file__dev_ptmx=yes
ac_cv_file__dev_ptc=no

.. cmdoption:: HOSTRUNNER

Program to run CPython for the host platform for cross-compilation.

.. versionadded:: 3.11


Cross compiling example::

Expand Down