Skip to content
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

gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS #92754

Merged
merged 7 commits into from Jun 20, 2022
18 changes: 18 additions & 0 deletions Doc/using/configure.rst
Expand Up @@ -747,6 +747,17 @@ Compiler flags
extensions. Use it when a compiler flag should *not* be part of the
distutils :envvar:`CFLAGS` once Python is installed (:issue:`21121`).

In particular, :envvar:`CFLAGS` should not contain:

- the compiler flag `-I` (for setting the search path for include files);
mkoeppe marked this conversation as resolved.
Show resolved Hide resolved
the `-I` flags are processed from left to right, and any flags in
:envvar:`CFLAGS` would take precedence over user- and package-supplied `-I`
flags.

- hardening flags such as `-Werror` because distributions cannot control
whether packages installed by users conform to such heightened
standards.

.. versionadded:: 3.5

.. envvar:: EXTRA_CFLAGS
Expand Down Expand Up @@ -859,6 +870,13 @@ Linker flags
:envvar:`CFLAGS_NODIST`. Use it when a linker flag should *not* be part of
the distutils :envvar:`LDFLAGS` once Python is installed (:issue:`35257`).

In particular, :envvar:`LDFLAGS` should not contain:

- the compiler flag `-L` (for setting the search path for libraries);
the `-L` flags are processed from left to right, and any flags in
:envvar:`CFLAGS` would take precedence over user- and package-supplied `-L`
flags.

.. envvar:: CONFIGURE_LDFLAGS_NODIST

Value of :envvar:`LDFLAGS_NODIST` variable passed to the ``./configure``
Expand Down
@@ -0,0 +1 @@
Expand the documentation of the configure variables `CFLAGS_NODIST`, `LDFLAGS_NODIST`.
mkoeppe marked this conversation as resolved.
Show resolved Hide resolved