pythongh-109054: Document configue variables

Author: vstinner

Doc/library/hashlib.rst

@@ -364,6 +364,8 @@ include a `salt <https://en.wikipedia.org/wiki/Salt_%28cryptography%29>`_.
    .. versionadded:: 3.6
 
 
+.. _hashlib-blake2:
+
 BLAKE2
 ------
 

Doc/using/configure.rst

@@ -60,7 +60,7 @@ See also :pep:`7` "Style Guide for C Code" and :pep:`11` "CPython platform
 support".
 
 
-Generated files
+Generated Files
 ===============
 
 To reduce build dependencies, Python source code contains multiple generated
@@ -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. ``-I<include dir>``.
+
+
+Linker Options
+--------------
+
+.. cmdoption:: LDFLAGS
+
+   Linker flags, e.g. ``-L<library directory>``.
+
+.. cmdoption:: LIBS
+
+   Libraries to pass to the linker, e.g. ``-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 ``liuuid``, 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
 -------------------
 
@@ -355,7 +485,7 @@ Install Options
    .. versionadded:: 3.6
 
 
-Performance options
+Performance Options
 -------------------
 
 Configuring Python using ``--enable-optimizations --with-lto`` (PGO + LTO) is
@@ -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
@@ -506,7 +649,7 @@ See also the :ref:`Python Development Mode <devmode>` and the
    :option:`--with-trace-refs` option).
 
 
-Debug options
+Debug Options
 -------------
 
 .. cmdoption:: --with-pydebug
@@ -581,7 +724,7 @@ Debug options
    .. versionadded:: 3.6
 
 
-Linker options
+Linker Options
 --------------
 
 .. cmdoption:: --enable-shared
@@ -596,7 +739,7 @@ Linker options
    .. versionadded:: 3.10
 
 
-Libraries options
+Libraries Options
 -----------------
 
 .. cmdoption:: --with-libs='lib1 ...'
@@ -775,6 +918,10 @@ 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.
+
 
 Cross compiling example::
 
@@ -787,7 +934,7 @@ Cross compiling example::
 Python Build System
 ===================
 
-Main files of the build system
+Main Files Of The Build System
 ------------------------------
 
 * :file:`configure.ac` => :file:`configure`;
@@ -796,7 +943,7 @@ Main files of the build system
 * :file:`Modules/Setup`: C extensions built by the Makefile using
   :file:`Module/makesetup` shell script;
 
-Main build steps
+Main Build Steps
 ----------------
 
 * C files (``.c``) are built as object files (``.o``).
@@ -805,7 +952,7 @@ Main build steps
   final ``python`` program.
 * C extensions are built by the Makefile (see :file:`Modules/Setup`).
 
-Main Makefile targets
+Main Makefile Targets
 ---------------------
 
 * ``make``: Build Python with the standard library.
@@ -826,7 +973,7 @@ Main Makefile targets
 * ``make distclean``: Same than ``make clean``, but remove also files created
   by the configure script.
 
-C extensions
+C Extensions
 ------------
 
 Some C extensions are built as built-in modules, like the ``sys`` module.
@@ -867,13 +1014,13 @@ built as a shared library, its ``PyInit_xxx()`` function is not exported,
 causing an :exc:`ImportError` on import.
 
 
-Compiler and linker flags
+Compiler and Linker Flags
 =========================
 
 Options set by the ``./configure`` script and environment variables and used by
 ``Makefile``.
 
-Preprocessor flags
+Preprocessor Flags
 ------------------
 
 .. envvar:: CONFIGURE_CPPFLAGS
@@ -903,7 +1050,7 @@ Preprocessor flags
 
    .. versionadded:: 3.2
 
-Compiler flags
+Compiler Flags
 --------------
 
 .. envvar:: CC
@@ -1033,7 +1180,7 @@ Compiler flags
    Default: empty string (not used).
 
 
-Linker flags
+Linker Flags
 ------------
 
 .. envvar:: LINKCC