diff mbox series

[bug#52505,v2,2/2] doc: Mention how to remedy "source file ... newer than compiled error".

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

Commit Message

jgart Dec. 15, 2021, 10:34 p.m. UTC
From: Guix Together <jgart@dismail.de>

* doc/contributing.texi (Running Guix Before It Is Installed): Mention
how to remedy "source file ... newer than compiled" error by running
`make -j`.

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 | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
diff mbox series

Patch

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 164e353884..a9bb310dab 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -243,6 +243,24 @@  local source tree; it simply updates the @file{~/.config/guix/current}
 symlink (@pxref{Invoking guix pull}).  Run @command{git pull} instead if
 you want to upgrade your local source tree.
 
+Sometimes, especially if you have recently updated your repository,
+running @command{./pre-inst-env} will print a message similar to the
+following example:
+
+@example
+;;; note: source file /home/user/projects/guix/guix/progress.scm
+;;;       newer than compiled /home/user/projects/guix/guix/progress.go
+@end example
+
+This is only a note and you can safely ignore it. You can get rid of
+the message by running @command{make -j4}. Until you do, Guile will run
+slightly slower because it will interpret the code instead of using
+prepared Guile object (@file{.go}) files.
+
+You can run @command{make} automatically as you work using
+@command{watchexec} from the @code{watchexec} package. For example,
+to build again each time you update a package file, you can run
+@samp{watchexec -w gnu/packages make -j4}.
 
 @node The Perfect Setup
 @section The Perfect Setup