Skip to content

Commit 57ba1da

Browse files
committed
pythongh-109054: Document configue variables
1 parent 6e1271e commit 57ba1da

File tree

2 files changed

+152
-0
lines changed

2 files changed

+152
-0
lines changed

Doc/library/hashlib.rst

+2
Original file line numberDiff line numberDiff line change
@@ -364,6 +364,8 @@ include a `salt <https://en.wikipedia.org/wiki/Salt_%28cryptography%29>`_.
364364
.. versionadded:: 3.6
365365

366366

367+
.. _hashlib-blake2:
368+
367369
BLAKE2
368370
------
369371

Doc/using/configure.rst

+150
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,154 @@ List all :file:`configure` script options using::
9494

9595
See also the :file:`Misc/SpecialBuilds.txt` in the Python source distribution.
9696

97+
Variables
98+
---------
99+
100+
.. cmdoption:: BOLT_APPLY_FLAGS
101+
102+
Arguments to ``llvm-bolt`` when creating a `BOLT optimized binary
103+
<https://github.com/facebookarchive/BOLT>`_.
104+
105+
.. cmdoption:: BOLT_INSTRUMENT_FLAGS
106+
107+
Arguments to ``llvm-bolt`` when instrumenting binaries.
108+
109+
.. cmdoption:: BZIP2_CFLAGS
110+
.. cmdoption:: BZIP2_LIBS
111+
112+
C compiler and linker flags to link Python to ``libbz2``, used by :mod:`bz2`
113+
module, overriding ``pkg-config``.
114+
115+
.. cmdoption:: CC
116+
117+
C compiler command.
118+
119+
.. cmdoption:: CFLAGS
120+
121+
C compiler flags.
122+
123+
.. cmdoption:: CPP
124+
125+
C preprocessor command.
126+
127+
.. cmdoption:: CPPFLAGS
128+
129+
C preprocessor flags, e.g. ``-I<include dir>``.
130+
131+
.. cmdoption:: CURSES_CFLAGS
132+
.. cmdoption:: CURSES_LIBS
133+
134+
C compiler and linker flags for ``libncurses`` or ``libncursesw``, used by
135+
:mod:`curses` module, overriding ``pkg-config``.
136+
137+
.. cmdoption:: GDBM_CFLAGS
138+
.. cmdoption:: GDBM_LIBS
139+
140+
C compiler and linker flags for ``gdbm``.
141+
142+
.. cmdoption:: HOSTRUNNER
143+
144+
Program to run CPython for the host platform for cross-compilation.
145+
146+
.. cmdoption:: LDFLAGS
147+
148+
Linker flags, e.g. ``-L<library directory>``.
149+
150+
See also :option:`LIBS`.
151+
152+
.. cmdoption:: LIBATOMIC
153+
154+
Linker flags when ``cpython/pyatomic.h`` header file is used.
155+
156+
Default: ``LIBATOMIC='-latomic'`` if ``libatomic`` is needed, or
157+
``LIBATOMIC=''`` otherwise (also the default when Python is cross-compiled).
158+
159+
.. versionadded:: 3.13
160+
161+
.. cmdoption:: LIBB2_CFLAGS
162+
.. cmdoption:: LIBB2_LIBS
163+
164+
C compiler and linker flags for ``libb2`` (:ref:`BLAKE2 <hashlib-blake2>`),
165+
used by :mod:`hashlib` module, overriding ``pkg-config``.
166+
167+
.. cmdoption:: LIBEDIT_CFLAGS
168+
.. cmdoption:: LIBEDIT_LIBS
169+
170+
C compiler and linker flags for ``libedit``, used by :mod:`readline` module,
171+
overriding ``pkg-config``.
172+
173+
.. cmdoption:: LIBFFI_CFLAGS
174+
.. cmdoption:: LIBFFI_LIBS
175+
176+
C compiler and linker flags for ``libffi``, used by :mod:`ctypes` module,
177+
overriding ``pkg-config``.
178+
179+
.. cmdoption:: LIBLZMA_CFLAGS
180+
.. cmdoption:: LIBLZMA_LIBS
181+
182+
C compiler and linker flags for ``liblzma``, used by :mod:`lzma` module,
183+
overriding ``pkg-config``.
184+
185+
.. cmdoption:: LIBREADLINE_CFLAGS
186+
.. cmdoption:: LIBREADLINE_LIBS
187+
188+
C compiler and linker flags for ``libreadline``, used by :mod:`readline`
189+
module, overriding ``pkg-config``.
190+
191+
.. cmdoption:: LIBS
192+
193+
Libraries to pass to the linker, e.g. ``-l<library>``.
194+
195+
See also :option:`LDFLAGS`.
196+
197+
.. cmdoption:: LIBSQLITE3_CFLAGS
198+
.. cmdoption:: LIBSQLITE3_LIBS
199+
200+
C compiler and linker flags for ``libsqlite3``, used by :mod:`sqlite3`
201+
module, overriding ``pkg-config``.
202+
203+
.. cmdoption:: LIBUUID_CFLAGS
204+
.. cmdoption:: LIBUUID_LIBS
205+
206+
C compiler and linker flags for ``liuuid``, used by :mod:`uuid` module,
207+
overriding ``pkg-config``.
208+
209+
.. cmdoption:: MACHDEP
210+
211+
Name for machine-dependent library files.
212+
213+
.. cmdoption:: PANEL_CFLAGS
214+
.. cmdoption:: PANEL_LIBS
215+
216+
C compiler and Linker flags for PANEL, overriding ``pkg-config``.
217+
218+
C compiler and linker flags for ``libpanel`` or ``libpanelw``, used by
219+
:mod:`curses.panel` module, overriding ``pkg-config``.
220+
221+
.. cmdoption:: PKG_CONFIG
222+
223+
Path to ``pkg-config`` utility.
224+
225+
.. cmdoption:: PKG_CONFIG_LIBDIR
226+
.. cmdoption:: PKG_CONFIG_PATH
227+
.. cmdoption:: PROFILE_TASK
228+
229+
Python command line arguments for PGO generation task.
230+
231+
Default: ``PROFILE_TASK='-m test --pgo --timeout=$(TESTTIMEOUT)'``.
232+
233+
.. cmdoption:: TCLTK_CFLAGS
234+
.. cmdoption:: TCLTK_LIBS
235+
236+
C compiler and linker flags for TCLTK, overriding ``pkg-config``.
237+
238+
.. cmdoption:: ZLIB_CFLAGS
239+
.. cmdoption:: ZLIB_LIBS
240+
241+
C compiler and linker flags for ``libzlib``, used by :mod:`gzip` module,
242+
overriding ``pkg-config``.
243+
244+
97245
General Options
98246
---------------
99247

@@ -750,6 +898,8 @@ for another CPU architecture or platform. Cross compiling requires a Python
750898
interpreter for the build platform. The version of the build Python must match
751899
the version of the cross compiled host Python.
752900

901+
See also :option:`HOSTRUNNER`.
902+
753903
.. cmdoption:: --build=BUILD
754904

755905
configure for building on BUILD, usually guessed by :program:`config.guess`.

0 commit comments

Comments
 (0)