[bug#52505] [PATCH 1/2] Guix Documentation Meetup Patches

[bug#52505] [PATCH 1/2] Guix Documentation Meetup Patches

[jgart via Guix-patches via]

Hi Guixers,

We had a great turnout for the first Guix Documentation Meetup.

Here are two patches that we worked on.

Let's keep it going :)

all best,

jgart

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

[jgart via Guix-patches via]

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(+)

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
-- 
2.34.0

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

[jgart via Guix-patches via]

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 --git a/doc/contributing.texi b/doc/contributing.texi
index 1bcb550aac..fa8dd376d2 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 -j}. Until you do, Guile will run
+slightly slower because it will interpret the code instead of using
+prepared Guile object (@code{.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
+@command{watchexec -w gnu/packages make -j}.
 
 @node The Perfect Setup
 @section The Perfect Setup
-- 
2.34.0

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

[zimoun]

Hi,

On Wed, 15 Dec 2021 at 12:36, jgart via Guix-patches via
<guix-patches@gnu.org> wrote:
>
> 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(+)

Cool!


> +the message by running @command{make -j}. Until you do, Guile will run

[...]

> +@command{watchexec -w gnu/packages make -j}.

Personally, I would not recommand inside the manual the command "make
-j", but instead "make" or "make -j4" (4 or whatever number); as it
was done in "guix environment" section [1].

1: <https://guix.gnu.org/manual/devel/en/guix.html#Invoking-guix-environment>


Cheers,
simon

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

[Nicolas Goaziou]

Hello,

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

> +This is only a note and you can safely ignore it. You can get rid of
> +the message by running @command{make -j}. Until you do, Guile will run
> +slightly slower because it will interpret the code instead of using
> +prepared Guile object (@code{.go}) files.

@code{.go} -> @file{.go}

> +You can run @command{make} automatically as you work using
> +@command{watchexec} from the @code{watchexec} package.

I'm not sure about the policy for the packages (assuming there is one).
I think @code{watchexec} should be used for the Guix variable containing
the package, and capitalized Watchexec may be appropriate for the
package name, which may not be the same as the variable.

Anyway, I'm just thinking out loud. In this situation.

> For example, to build again each time you update a package file, you
> can run +@command{watchexec -w gnu/packages make -j}.

According to the Texinfo manual, entire shell commands may use @samp.
@command is for the command name. Thus:

@command{watchexec -w gnu/packages make -j} -> @samp{watchexec -w gnu/packages make -j}

Regards,
-- 
Nicolas Goaziou

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

[Nicolas Goaziou]

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,
-- 
Nicolas Goaziou

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

[jgart via Guix-patches via]

From: Guix Together <jgart@dismail.de>

Hi all,

Here is version 2 with your requested changes. Let me know if there is anything else I might have missed.

Thank you for the review.

all best,

jgart

* 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(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index db1c4c6921..164e353884 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
-- 
2.34.0

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

[jgart via Guix-patches via]

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 --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
-- 
2.34.0

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

[jgart via Guix-patches via]

From: Guix Together <jgart@dismail.de>

Hi Guixers,

Here is version 3 of our Documentation patchset. 

Ryan had pointed out some other "two spaces after sentence" issues offlist.

all best,

jgart

* 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(+)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index db1c4c6921..164e353884 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
-- 
2.34.0

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

[jgart via Guix-patches via]

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 --git a/doc/contributing.texi b/doc/contributing.texi
index 164e353884..f3182b1564 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
-- 
2.34.0

bug#52505: [PATCH 1/2] Guix Documentation Meetup Patches

[Nicolas Goaziou]

Hello,

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

> Here are two patches that we worked on.

Applied v3. Thank you!

Regards,
-- 
Nicolas Goaziou

[bug#52505] [PATCH 1/2] Guix Documentation Meetup Patches

[jgart via Guix-patches via]

On Fri, 28 Jan 2022 10:16:07 +0100 Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Hello,
> 
> jgart via Guix-patches via <guix-patches@gnu.org> writes:
> 
> > Here are two patches that we worked on.
> 
> Applied v3. Thank you!

Thanks Nicolas!

much appreciated,

jgart