[Python-checkins] gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-92754)

Mon Jun 20 10:15:13 EDT 2022

https://github.com/python/cpython/commit/2454dbe6527fb96eb880c1957905c8cf5934f5be
commit: 2454dbe6527fb96eb880c1957905c8cf5934f5be
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022年06月20日T07:14:51-07:00
summary:
gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (GH-92754)
(cherry picked from commit 61f24e7885bed096b5d7f75aff13c1001994b35a)
Co-authored-by: Matthias Köppe <mkoeppe at math.ucdavis.edu>
files:
M Doc/using/configure.rst

diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst
index 14ffdd760f012..13c339465c1fc 100644
--- a/Doc/using/configure.rst
+++ b/Doc/using/configure.rst
@@ -652,6 +652,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
@@ -764,6 +775,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``
