summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGregory P. Smith <greg@krypto.org>2023-12-21 07:32:13 (GMT)
committerGitHub <noreply@github.com>2023-12-21 07:32:13 (GMT)
commit103c4ea27464cef8d1793dab347f5ff3629dc243 (patch)
tree4f8d59207ab526a9b247a972ebb97bb17cf94b47
parenta2dd0e7038ad65a2464541f91604524d871d98a7 (diff)
downloadcpython-103c4ea27464cef8d1793dab347f5ff3629dc243.zip
cpython-103c4ea27464cef8d1793dab347f5ff3629dc243.tar.gz
cpython-103c4ea27464cef8d1793dab347f5ff3629dc243.tar.bz2
gh-112305: Fix check-clean-src to detect frozen_modules .h files. (#113344)
A typo left this check broken so many of us who do out-of-tree builds were seeing strange failures due to bad `Python/frozen_modules/*.h` files being picked up from the source tree and used at build time from different Python versions leading to errors like: `Fatal Python error: _PyImport_InitCore: failed to initialize importlib` Or similar once our build got to an "invoke the interpreter" bootstrapping step due to incorrect bytecode being embedded.
-rw-r--r--Makefile.pre.in6
-rw-r--r--Misc/NEWS.d/next/Build/2023-12-21-05-35-06.gh-issue-112305.VfqQPx.rst3
2 files changed, 7 insertions, 2 deletions
diff --git a/Makefile.pre.in b/Makefile.pre.in
index 4e2ec97..954cde8 100644
--- a/Makefile.pre.in
+++ b/Makefile.pre.in
@@ -657,11 +657,13 @@ check-clean-src:
@if test -n "$(VPATH)" -a \( \
-f "$(srcdir)/$(BUILDPYTHON)" \
-o -f "$(srcdir)/Programs/python.o" \
- -o -f "$(srcdir)\Python/frozen_modules/importlib._bootstrap.h" \
+ -o -f "$(srcdir)/Python/frozen_modules/importlib._bootstrap.h" \
\); then \
echo "Error: The source directory ($(srcdir)) is not clean" ; \
echo "Building Python out of the source tree (in $(abs_builddir)) requires a clean source tree ($(abs_srcdir))" ; \
- echo "Try to run: make -C \"$(srcdir)\" clean" ; \
+ echo "Build artifacts such as .o files, executables, and Python/frozen_modules/*.h must not exist within $(srcdir)." ; \
+ echo "Try to run:" ; \
+ echo " (cd \"$(srcdir)\" && make clean || git clean -fdx -e Doc/venv)" ; \
exit 1; \
fi
diff --git a/Misc/NEWS.d/next/Build/2023-12-21-05-35-06.gh-issue-112305.VfqQPx.rst b/Misc/NEWS.d/next/Build/2023-12-21-05-35-06.gh-issue-112305.VfqQPx.rst
new file mode 100644
index 0000000..2df3207
--- /dev/null
+++ b/Misc/NEWS.d/next/Build/2023-12-21-05-35-06.gh-issue-112305.VfqQPx.rst
@@ -0,0 +1,3 @@
+Fixed the ``check-clean-src`` step performed on out of tree builds to detect
+errant ``$(srcdir)/Python/frozen_modules/*.h`` files and recommend
+appropriate source tree cleanup steps to get a working build again.