diff mbox series

[bug#52505,1/2] doc: Explain the use of make clean-go when an ABI mismatch occurs.

Message ID 20211215112040.25851-1-jgart@dismail.de
State Accepted
Headers show
Series [bug#52505,1/2] doc: Explain the use of make clean-go when an ABI mismatch occurs. | expand

Commit Message

jgart Dec. 15, 2021, 11:20 a.m. UTC 
From: Guix Together <jgart@dismail.de>

* doc/contributing.texi (Building from Git): Adds section on using
make clean-go.

Co-authored-by: jgart <jgart@dismail.de>
Co-authored-by: Julien Lepiller <julien@lepiller.eu>
Co-authored-by: Ryan Prior <rprior@protonmail.com>
Co-authored-by: Blake Shaw <blake@nonconstructivism.com>
---
 doc/contributing.texi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Nicolas Goaziou Dec. 15, 2021, 1:08 p.m. UTC | #1 
Hello,

jgart via Guix-patches via <guix-patches@gnu.org> writes:

> +This means that one of the record types that Guix defines (in this
> +example, the @code{origin} record) has changed, and all of guix needs
> +to be recompiled to take that change into account. To do so, run
                                                    ^^^
You need to put two spaces at the end of sentences.

Regards,
diff mbox series

Patch

diff --git a/doc/contributing.texi b/doc/contributing.texi
index db1c4c6921..1bcb550aac 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -157,6 +157,18 @@  You are advised to run @command{make authenticate} after every
 changes to the repository.
 @end quotation
 
+After updating the repository, @command{make} might fail with an error
+similar to the following example:
+
+@example
+error: failed to load 'gnu/packages/dunst.scm':
+ice-9/eval.scm:293:34: In procedure abi-check: #<record-type <origin>>: record ABI mismatch; recompilation needed
+@end example
+
+This means that one of the record types that Guix defines (in this
+example, the @code{origin} record) has changed, and all of guix needs
+to be recompiled to take that change into account. To do so, run
+@command{make clean-go} followed by @command{make}.
 
 @node Running Guix Before It Is Installed
 @section Running Guix Before It Is Installed