Subject: [PATCH v2] doc: Add message for common error about make check-system

From: Richard Sent <[email-masked]>
Date: Mon, 17 Jun 2024 21:02:29 -0400

* doc/contributing.texi (Running the Test Suite): Mention that make clean-go
may need to be run before running make check-system when previous builds were
run with different work trees. See https://issues.guix.gnu.org/47573.

Change-Id: I4b68d3a05f1425505816db969284487d725840d6
---
Adjusted the phrasing. If we think it's best to hold on merging this
until we determine how common of an occurrence this is or (better yet)
resolve the issue entirely, there's no complaints by me. I'll leave
that decision up to you all. :)

 doc/contributing.texi | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 938c8bfdb1..6f0acc8c1f 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -411,6 +411,20 @@ Running the Test Suite
 substitutes are available for their dependencies (@pxref{Substitutes}).
 Some of them require a lot of storage space to hold VM images.
 
+If you encounter an error like:
+
+@example
+Compiling Scheme modules...
+ice-9/eval.scm:142:16: In procedure compile-top-call:
+error: all-system-tests: unbound variable
+hint: Did you forget `(use-modules (gnu tests))'?
+@end example
+
+@noindent
+there may be inconsistencies in the work tree from previous builds.  To
+resolve this, try running @command{make clean-go} followed by
+@command{make}.
+
 Again in case of test failures, please send @email{bug-guix@@gnu.org}
 all the details.

base-commit: b993f4735d41e690dbafb8ee2e17fce996a8cf20
-- 
2.45.1