From: ludo@gnu.org (Ludovic Courtès)
To: julien lepiller <julien@lepiller.eu>
Cc: guix-devel@gnu.org
Subject: Reporting module errors
Date: Tue, 07 Nov 2017 23:47:35 +0100 [thread overview]
Message-ID: <87zi7xwvso.fsf_-_@gnu.org> (raw)
In-Reply-To: <ae132af1ad45b1d4c18cdd1356ec3b1f@lepiller.eu> (julien lepiller's message of "Tue, 07 Nov 2017 17:25:33 +0100")
[-- Attachment #1: Type: text/plain, Size: 2193 bytes --]
Hello!
You’re too fast! :-)
julien lepiller <julien@lepiller.eu> skribis:
> +(define (import-error type module syntax)
> + (define package-hint
> + (string-append
> + "Hint: You may use `guix package --show=foo | grep location` to search\n"
> + "Hint: for foo's location.\n"
> + "Hint: If you get the line \"location: gnu/packages/bar.scm:174:2\",\n"
> + "Hint: you want to add bar in use-package-modules."))
> + (define service-hint
> + (string-append
> + "Hint: You may use `guix system search foo` to search for foo's location.\n"
> + "Hint: If you get the line \"location: gnu/services/bar.scm:188:2\",\n"
> + "Hint: you want to add bar in use-service-modules."))
> + (error (string-append
> + type " module \"" module "\" does not exist.\n"
> + "Check the \"" syntax "\" line in your configuration.\n"
> + (if (equal? type "Package")
> + package-hint
> + (if (equal? type "Service")
> + service-hint
> + "")))))
> +
> (define-syntax-rule (use-package-modules module ...)
> - (use-modules (gnu packages module) ...))
> + (begin
> + (catch #t (lambda () (use-modules (gnu packages module)))
> + (lambda _
> + (import-error "Package" (symbol->string 'module) "use-package-modules")))
> + ...))
That’s a great suggestion!
I’d propose a variant of it, see below. With this, one gets a message
like:
/tmp/config.scm:6:0: module (gnu packages foobar) could not be found
where line 6 is:
(use-package-modules foobar)
How does that sound?
It lacks the hints that you were proposing, which isn’t great, but I
think we’d need to provide a homogeneous and internationalized API in
(guix ui) if we are to display hints. But overall I like the idea of
providing hints somehow.
Perhaps we could simply introduce another condition type for hints as a
first step, similar to ‘&message’?
Speaking of hints, we should have something that suggests a module name
based on the Levenshtein distance with available modules. :-)
Thanks,
Ludo’.
[-- Attachment #2: Type: text/x-patch, Size: 5842 bytes --]
diff --git a/gnu.scm b/gnu.scm
index 913ce6160..6dde968f1 100644
--- a/gnu.scm
+++ b/gnu.scm
@@ -1,5 +1,5 @@
;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2015 Joshua S. Grant <jgrant@parenthetical.io>
;;; Copyright © 2017 Mathieu Othacehe <m.othacehe@gmail.com>
;;;
@@ -19,6 +19,10 @@
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu)
+ #:use-module (guix utils)
+ #:use-module (srfi srfi-34)
+ #:use-module (srfi srfi-35)
+ #:use-module (ice-9 match)
#:export (use-package-modules
use-service-modules
use-system-modules))
@@ -52,13 +56,46 @@
(module-use! i (resolve-interface m))))
%public-modules)))
+(define (%try-use-modules modules location)
+ "Attempt to load all of MODULES. Report errors as coming from LOCATION, a
+source property alist."
+ (define (location->string loc)
+ (match loc
+ (#f "")
+ (($ <location> file line column)
+ (format #f "~a:~a:~a: " file line column))))
+
+ (for-each (lambda (module)
+ (catch 'misc-error
+ (lambda ()
+ (process-use-modules `((,module))))
+ (lambda _
+ (raise (condition
+ (&message
+ ;; TODO: Suggest a module with a similar name.
+ (message
+ (let-syntax ((G_ (syntax-rules ()
+ ((_ str) str))))
+ (format #f
+ (G_ "module ~a could not be found~%")
+ module))))
+ (&error-location
+ (location location)))))))
+ modules))
+
+(define-syntax-rule (try-use-modules modules ...)
+ (eval-when (expand load eval)
+ (%try-use-modules '(modules ...)
+ (source-properties->location
+ (current-source-location)))))
+
(define-syntax-rule (use-package-modules module ...)
- (use-modules (gnu packages module) ...))
+ (try-use-modules (gnu packages module) ...))
(define-syntax-rule (use-service-modules module ...)
- (use-modules (gnu services module) ...))
+ (try-use-modules (gnu services module) ...))
(define-syntax-rule (use-system-modules module ...)
- (use-modules (gnu system module) ...))
+ (try-use-modules (gnu system module) ...))
;;; gnu.scm ends here
diff --git a/guix/ui.scm b/guix/ui.scm
index 3c8734a7d..cd3a44fb4 100644
--- a/guix/ui.scm
+++ b/guix/ui.scm
@@ -272,9 +272,15 @@ ARGS is the list of arguments received by the 'throw' handler."
(location->string loc) message)))
(('srfi-34 obj)
(if (message-condition? obj)
- (report-error (G_ "~a~%")
- (gettext (condition-message obj)
- %gettext-domain))
+ (if (error-location? obj)
+ (format (current-error-port)
+ (G_ "~a: ~a~%")
+ (location->string (error-location obj))
+ (gettext (condition-message obj)
+ %gettext-domain))
+ (report-error (G_ "~a~%")
+ (gettext (condition-message obj)
+ %gettext-domain)))
(report-error (G_ "exception thrown: ~s~%") obj)))
((error args ...)
(report-error (G_ "failed to load '~a':~%") file)
@@ -538,6 +544,11 @@ interpreted."
directories:~{ ~a~}~%")
(file-search-error-file-name c)
(file-search-error-search-path c)))
+ ((and (error-location? c) (message-condition? c))
+ (format (current-error-port)
+ (G_ "~a: ~a~%")
+ (location->string (error-location c))
+ (gettext (condition-message c) %gettext-domain)))
((message-condition? c)
;; Normally '&message' error conditions have an i18n'd message.
(leave (G_ "~a~%")
diff --git a/guix/utils.scm b/guix/utils.scm
index eb1ec29b3..e25e2299e 100644
--- a/guix/utils.scm
+++ b/guix/utils.scm
@@ -28,6 +28,7 @@
#:use-module (srfi srfi-9)
#:use-module (srfi srfi-11)
#:use-module (srfi srfi-26)
+ #:use-module (srfi srfi-35)
#:use-module (srfi srfi-39)
#:use-module (ice-9 binary-ports)
#:autoload (rnrs io ports) (make-custom-binary-input-port)
@@ -60,6 +61,10 @@
source-properties->location
location->source-properties
+ &error-location
+ error-location?
+ error-location
+
nix-system->gnu-triplet
gnu-triplet->nix-system
%current-system
@@ -750,6 +755,10 @@ a location object."
(column . ,(location-column loc))
(filename . ,(location-file loc))))
+(define-condition-type &error-location &error
+ error-location?
+ (location error-location)) ;<location>
+
;;; Local Variables:
;;; eval: (put 'call-with-progress-reporter 'scheme-indent-function 1)
;;; End:
diff --git a/po/guix/POTFILES.in b/po/guix/POTFILES.in
index e3f767cc6..6510b99e8 100644
--- a/po/guix/POTFILES.in
+++ b/po/guix/POTFILES.in
@@ -1,5 +1,6 @@
# List of source files which contain translatable strings.
# This should be source files of the various tools, and not package modules.
+gnu.scm
gnu/packages.scm
gnu/services.scm
gnu/system.scm
next prev parent reply other threads:[~2017-11-07 22:47 UTC|newest]
Thread overview: 50+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-06 20:12 The usability of Guix configurations myglc2
2017-11-06 22:16 ` Leo Famulari
2017-11-06 23:26 ` myglc2
2017-11-06 23:26 ` bug#29072: " myglc2
2017-11-07 1:56 ` myglc2
2017-11-07 1:56 ` myglc2
2017-11-07 11:05 ` julien lepiller
2017-11-07 12:52 ` Hartmut Goebel
2017-11-07 13:13 ` julien lepiller
2017-11-07 14:11 ` myglc2
2017-11-07 14:52 ` julien lepiller
2017-11-07 15:59 ` myglc2
2017-11-07 16:25 ` [PATCH] " julien lepiller
[not found] ` <867ev2t13i.fsf@gmail.com>
2017-11-07 21:27 ` Julien Lepiller
2017-11-07 22:56 ` myglc2
2017-11-07 22:47 ` Ludovic Courtès [this message]
2017-11-08 1:26 ` Reporting module errors myglc2
2017-11-08 10:52 ` Hartmut Goebel
2017-11-08 14:02 ` Ludovic Courtès
2017-11-08 13:09 ` [PATCH 0/6] Error reporting and hints for missing modules Ludovic Courtès
2017-11-08 13:09 ` [PATCH 1/6] ui: Introduce (guix i18n) Ludovic Courtès
2017-11-08 13:09 ` [PATCH 2/6] ui: Define and honor '&error-location' and '&fix-hint' conditions Ludovic Courtès
2017-11-08 13:09 ` [PATCH 3/6] services: 'fold-service-types' honors its seed Ludovic Courtès
2017-11-08 13:09 ` [PATCH 4/6] services: 'fold-service-types' includes (gnu services) Ludovic Courtès
2017-11-08 13:09 ` [PATCH 5/6] services: Add 'lookup-service-types' Ludovic Courtès
2017-11-08 13:09 ` [PATCH 6/6] gnu: Improve error reporting of the use-.*modules macros Ludovic Courtès
2017-11-11 2:02 ` Chris Marusich
2017-11-11 13:56 ` Ludovic Courtès
2017-11-11 17:00 ` Chris Marusich
2017-11-08 15:33 ` [PATCH 0/6] Error reporting and hints for missing modules julien lepiller
2017-11-08 17:42 ` myglc2
2017-11-08 19:07 ` myglc2
2017-11-08 21:42 ` Ludovic Courtès
2017-11-09 23:04 ` Ludovic Courtès
2017-11-10 14:47 ` myglc2
2017-11-10 23:01 ` Julien Lepiller
2017-11-11 22:00 ` Ludovic Courtès
2017-11-11 22:02 ` Ludovic Courtès
2017-11-14 1:12 ` myglc2
2017-11-30 10:44 ` Ludovic Courtès
2017-11-07 14:45 ` The usability of Guix configurations Hartmut Goebel
2017-11-07 2:30 ` bug#29072: " myglc2
2017-11-07 2:30 ` myglc2
2017-11-07 3:03 ` myglc2
2017-11-07 2:59 ` myglc2
2017-11-07 20:54 ` myglc2
2017-11-06 22:16 ` bug#29072: " Leo Famulari
2017-11-07 10:23 ` Ludovic Courtès
2017-11-07 10:23 ` Ludovic Courtès
2017-11-08 19:40 ` myglc2
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zi7xwvso.fsf_-_@gnu.org \
--to=ludo@gnu.org \
--cc=guix-devel@gnu.org \
--cc=julien@lepiller.eu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.