From 066dae9171862d819b7efe7dd6ff7584b11d7b20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20K=C3=B6ppe?= Date: Mon, 20 Jun 2022 09:58:02 -0400 Subject: [PATCH] gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-92754) (cherry picked from commit 61f24e7885bed096b5d7f75aff13c1001994b35a) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Matthias Köppe --- Doc/using/configure.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst index 4bf9b84e6b90fd..8ce9884c76fe21 100644 --- a/Doc/using/configure.rst +++ b/Doc/using/configure.rst @@ -748,6 +748,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). + 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 @@ -860,6 +871,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:`LDFLAGS` would take precedence over user- and package-supplied `-L` + flags. + .. envvar:: CONFIGURE_LDFLAGS_NODIST Value of :envvar:`LDFLAGS_NODIST` variable passed to the ``./configure``