[bug#79577,v2] monad-repl: Add "build-options" command.

Message ID bea6a3bb1e829d7aeb8da9a9a5ccfe486d44bd0e.1759708140.git.~@wolfsden.cz
State New
Headers
Series [bug#79577,v2] monad-repl: Add "build-options" command. |

Commit Message

Tomas Volf Oct. 5, 2025, 11:49 p.m. UTC
There currently was no way to disable build offload for ,build from inside the
REPL.  Since offloaded builds sometimes do not error report entirely
correctly, it is useful to be able to switch to local builds.

This commit adds new ,build-options meta command, which allows to specify
build options, including #:offload?.

* guix/monad-repl.scm (%build-options): New variable.
(evaluate/print-with-store, package-argument-command): Use it.
(build-options): New meta command to set it.
* doc/guix.texi (Using Guix Interactively): Document it.
---
 doc/guix.texi       | 10 ++++++++++
 guix/monad-repl.scm | 34 ++++++++++++++++++++++++++--------
 2 files changed, 36 insertions(+), 8 deletions(-)
  

Comments

Ludovic Courtès Oct. 6, 2025, 8:36 a.m. UTC | #1
Hi,

Tomas Volf <~@wolfsden.cz> writes:

> There currently was no way to disable build offload for ,build from inside the
> REPL.  Since offloaded builds sometimes do not error report entirely
> correctly, it is useful to be able to switch to local builds.
>
> This commit adds new ,build-options meta command, which allows to specify
> build options, including #:offload?.
>
> * guix/monad-repl.scm (%build-options): New variable.
> (evaluate/print-with-store, package-argument-command): Use it.
> (build-options): New meta command to set it.
> * doc/guix.texi (Using Guix Interactively): Document it.

Applied, thanks!
  
Maxim Cournoyer Oct. 7, 2025, 12:55 a.m. UTC | #2
Hi,

Ludovic Courtès <ludo@gnu.org> writes:

> Hi,
>
> Tomas Volf <~@wolfsden.cz> writes:
>
>> There currently was no way to disable build offload for ,build from inside the
>> REPL.  Since offloaded builds sometimes do not error report entirely
>> correctly, it is useful to be able to switch to local builds.
>>
>> This commit adds new ,build-options meta command, which allows to specify
>> build options, including #:offload?.
>>
>> * guix/monad-repl.scm (%build-options): New variable.
>> (evaluate/print-with-store, package-argument-command): Use it.
>> (build-options): New meta command to set it.
>> * doc/guix.texi (Using Guix Interactively): Document it.

Would there be a way to set these options to a default of my choosing?
I want to see the build log most of the time, when hacking on a package,
for example.

Or perhaps the verbosity should be set higher by default for this, as
it's meant for interactive usage?
  
Tomas Volf Oct. 7, 2025, 9:47 a.m. UTC | #3
Hi,

Maxim Cournoyer <maxim@guixotic.coop> writes:

>>> This commit adds new ,build-options meta command, which allows to specify
>>> build options, including #:offload?.
>>>
>>> * guix/monad-repl.scm (%build-options): New variable.
>>> (evaluate/print-with-store, package-argument-command): Use it.
>>> (build-options): New meta command to set it.
>>> * doc/guix.texi (Using Guix Interactively): Document it.
>
> Would there be a way to set these options to a default of my choosing?

For sure, you can do that from .guile.

> I want to see the build log most of the time, when hacking on a package,
> for example.

I too want to see the logs!  For that reason, I have the following in my
.guile (inside a guard checking that we are in guix repl):

--8<---------------cut here---------------start------------->8---
  (display "Increasing build verbosity...\n")
  (set! (@@ (guix monad-repl) %build-verbosity) 3)
--8<---------------cut here---------------end--------------->8---

>
> Or perhaps the verbosity should be set higher by default for this, as
> it's meant for interactive usage?

Maybe?  I find that the increased verbosity works for me, but can
definitely see arguments for the current default.  So no strong opinion.

Tomas
  

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 3fd2a13968..5c82445619 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -13204,6 +13204,16 @@  Using Guix Interactively
 output file name(s).
 @end deffn
 
+@deffn {REPL command} build-options @var{options}
+Set build options for rest of the REPL commands to @var{options}.  Must
+be a list of keywords with values accepted by procedure
+@code{(@@ (guix store) set-build-options)}.  An example would be:
+
+@example
+,build-options '(#:offload? #f)
+@end example
+@end deffn
+
 @deffn {REPL command} lower @var{object}
 Lower @var{object} into a derivation or store file name and return it.
 @end deffn
diff --git a/guix/monad-repl.scm b/guix/monad-repl.scm
index d6b39112b7..db4fe3c699 100644
--- a/guix/monad-repl.scm
+++ b/guix/monad-repl.scm
@@ -1,5 +1,6 @@ 
 ;;; GNU Guix --- Functional package management for GNU
 ;;; Copyright © 2014-2016, 2022-2023 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2025 Tomas Volf <~@wolfsden.cz>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -81,13 +82,18 @@  (define %build-verbosity
   ;; Current build verbosity level.
   1)
 
+(define %build-options
+  ;; Additional build options.
+  '())
+
 (define* (evaluate/print-with-store mvalue #:key build?)
   "Run monadic value MVALUE in the store monad and print its value."
   (with-store store
-    (set-build-options store
-                       #:print-build-trace #t
-                       #:print-extended-build-trace? #t
-                       #:multiplexed-build-output? #t)
+    (apply set-build-options store
+           #:print-build-trace #t
+           #:print-extended-build-trace? #t
+           #:multiplexed-build-output? #t
+           %build-options)
     (with-status-verbosity %build-verbosity
       (let* ((guile  (or (%guile-for-build)
                          (default-guile-derivation store)))
@@ -130,6 +136,17 @@  (define-meta-command ((build guix) repl (form))
   (evaluate/print-with-store (lower-object (repl-eval repl form))
                              #:build? #t))
 
+(define-meta-command ((build-options guix) repl (opts))
+  "build-options OPTIONS
+Set build options to OPTIONS.  Print previous value (to allow easy restore).
+
+Must be a list of keywords with values accepted by procedure
+(@ (guix store) set-build-options).  An example would be:
+
+    ,build-options '(#:offload? #f)"
+  (repl-print repl %build-options)
+  (set! %build-options (repl-eval repl opts)))
+
 (define-meta-command ((enter-store-monad guix) repl)
   "enter-store-monad
 Enter a REPL for values in the store monad."
@@ -172,10 +189,11 @@  (define (package-argument-command repl form keyword default)
        (define phases
          (parameterize ((%graft? #f))
            (with-store store
-             (set-build-options store
-                                #:print-build-trace #t
-                                #:print-extended-build-trace? #t
-                                #:multiplexed-build-output? #t)
+             (apply set-build-options store
+                    #:print-build-trace #t
+                    #:print-extended-build-trace? #t
+                    #:multiplexed-build-output? #t
+                    %build-options)
              (run-with-store store
                (mlet %store-monad ((exp (bag->derivation bag*)))
                  (if (gexp? exp)