Skip to content

Commit e476171

Browse files
committed
Reorganize the doc
1 parent 57ba1da commit e476171

File tree

1 file changed

+154
-150
lines changed

1 file changed

+154
-150
lines changed

Doc/using/configure.rst

Lines changed: 154 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -94,154 +94,6 @@ 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-
24597
General Options
24698
---------------
24799

@@ -437,6 +289,143 @@ General Options
437289

438290
.. versionadded:: 3.13
439291

292+
.. cmdoption:: PKG_CONFIG
293+
294+
Path to ``pkg-config`` utility.
295+
296+
.. cmdoption:: PKG_CONFIG_LIBDIR
297+
.. cmdoption:: PKG_CONFIG_PATH
298+
299+
``pkg-config`` options.
300+
301+
302+
C Compiler Options
303+
------------------
304+
305+
.. cmdoption:: CC
306+
307+
C compiler command.
308+
309+
.. cmdoption:: CFLAGS
310+
311+
C compiler flags.
312+
313+
.. cmdoption:: CPP
314+
315+
C preprocessor command.
316+
317+
.. cmdoption:: CPPFLAGS
318+
319+
C preprocessor flags, e.g. ``-I<include dir>``.
320+
321+
322+
Linker Options
323+
--------------
324+
325+
.. cmdoption:: LDFLAGS
326+
327+
Linker flags, e.g. ``-L<library directory>``.
328+
329+
.. cmdoption:: LIBATOMIC
330+
331+
Linker flags when ``cpython/pyatomic.h`` header file is used.
332+
333+
Default: ``LIBATOMIC='-latomic'`` if ``libatomic`` is needed, or
334+
``LIBATOMIC=''`` otherwise (also the default when Python is cross-compiled).
335+
336+
.. versionadded:: 3.13
337+
338+
.. cmdoption:: LIBS
339+
340+
Libraries to pass to the linker, e.g. ``-l<library>``.
341+
342+
.. cmdoption:: MACHDEP
343+
344+
Name for machine-dependent library files.
345+
346+
347+
Libraries Options
348+
-----------------
349+
350+
.. cmdoption:: BZIP2_CFLAGS
351+
.. cmdoption:: BZIP2_LIBS
352+
353+
C compiler and linker flags to link Python to ``libbz2``, used by :mod:`bz2`
354+
module, overriding ``pkg-config``.
355+
356+
.. cmdoption:: CURSES_CFLAGS
357+
.. cmdoption:: CURSES_LIBS
358+
359+
C compiler and linker flags for ``libncurses`` or ``libncursesw``, used by
360+
:mod:`curses` module, overriding ``pkg-config``.
361+
362+
.. cmdoption:: GDBM_CFLAGS
363+
.. cmdoption:: GDBM_LIBS
364+
365+
C compiler and linker flags for ``gdbm``.
366+
367+
.. cmdoption:: LIBB2_CFLAGS
368+
.. cmdoption:: LIBB2_LIBS
369+
370+
C compiler and linker flags for ``libb2`` (:ref:`BLAKE2 <hashlib-blake2>`),
371+
used by :mod:`hashlib` module, overriding ``pkg-config``.
372+
373+
.. cmdoption:: LIBEDIT_CFLAGS
374+
.. cmdoption:: LIBEDIT_LIBS
375+
376+
C compiler and linker flags for ``libedit``, used by :mod:`readline` module,
377+
overriding ``pkg-config``.
378+
379+
.. cmdoption:: LIBFFI_CFLAGS
380+
.. cmdoption:: LIBFFI_LIBS
381+
382+
C compiler and linker flags for ``libffi``, used by :mod:`ctypes` module,
383+
overriding ``pkg-config``.
384+
385+
.. cmdoption:: LIBLZMA_CFLAGS
386+
.. cmdoption:: LIBLZMA_LIBS
387+
388+
C compiler and linker flags for ``liblzma``, used by :mod:`lzma` module,
389+
overriding ``pkg-config``.
390+
391+
.. cmdoption:: LIBREADLINE_CFLAGS
392+
.. cmdoption:: LIBREADLINE_LIBS
393+
394+
C compiler and linker flags for ``libreadline``, used by :mod:`readline`
395+
module, overriding ``pkg-config``.
396+
397+
.. cmdoption:: LIBSQLITE3_CFLAGS
398+
.. cmdoption:: LIBSQLITE3_LIBS
399+
400+
C compiler and linker flags for ``libsqlite3``, used by :mod:`sqlite3`
401+
module, overriding ``pkg-config``.
402+
403+
.. cmdoption:: LIBUUID_CFLAGS
404+
.. cmdoption:: LIBUUID_LIBS
405+
406+
C compiler and linker flags for ``liuuid``, used by :mod:`uuid` module,
407+
overriding ``pkg-config``.
408+
409+
.. cmdoption:: PANEL_CFLAGS
410+
.. cmdoption:: PANEL_LIBS
411+
412+
C compiler and Linker flags for PANEL, overriding ``pkg-config``.
413+
414+
C compiler and linker flags for ``libpanel`` or ``libpanelw``, used by
415+
:mod:`curses.panel` module, overriding ``pkg-config``.
416+
417+
.. cmdoption:: TCLTK_CFLAGS
418+
.. cmdoption:: TCLTK_LIBS
419+
420+
C compiler and linker flags for TCLTK, overriding ``pkg-config``.
421+
422+
.. cmdoption:: ZLIB_CFLAGS
423+
.. cmdoption:: ZLIB_LIBS
424+
425+
C compiler and linker flags for ``libzlib``, used by :mod:`gzip` module,
426+
overriding ``pkg-config``.
427+
428+
440429
WebAssembly Options
441430
-------------------
442431

@@ -576,6 +565,19 @@ also be used to improve performance.
576565

577566
.. versionadded:: 3.12
578567

568+
.. cmdoption:: BOLT_APPLY_FLAGS
569+
570+
Arguments to ``llvm-bolt`` when creating a `BOLT optimized binary
571+
<https://github.com/facebookarchive/BOLT>`_.
572+
573+
.. versionadded:: 3.12
574+
575+
.. cmdoption:: BOLT_INSTRUMENT_FLAGS
576+
577+
Arguments to ``llvm-bolt`` when instrumenting binaries.
578+
579+
.. versionadded:: 3.12
580+
579581
.. cmdoption:: --with-computed-gotos
580582

581583
Enable computed gotos in evaluation loop (enabled by default on supported
@@ -898,8 +900,6 @@ for another CPU architecture or platform. Cross compiling requires a Python
898900
interpreter for the build platform. The version of the build Python must match
899901
the version of the cross compiled host Python.
900902

901-
See also :option:`HOSTRUNNER`.
902-
903903
.. cmdoption:: --build=BUILD
904904

905905
configure for building on BUILD, usually guessed by :program:`config.guess`.
@@ -925,6 +925,10 @@ See also :option:`HOSTRUNNER`.
925925
ac_cv_file__dev_ptmx=yes
926926
ac_cv_file__dev_ptc=no
927927

928+
.. cmdoption:: HOSTRUNNER
929+
930+
Program to run CPython for the host platform for cross-compilation.
931+
928932

929933
Cross compiling example::
930934

0 commit comments

Comments
 (0)