From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
To: 43627@debbugs.gnu.org
Cc: ludo@gnu.org, Maxim Cournoyer <maxim.cournoyer@gmail.com>
Subject: [bug#43627] [PATCH core-updates v2 1/2] guix: Add an append-separator? field to the <search-path-specification> record.
Date: Tue, 30 Mar 2021 11:51:01 -0400 [thread overview]
Message-ID: <20210330155102.16610-1-maxim.cournoyer@gmail.com> (raw)
In-Reply-To: <87blhtt6d6.fsf@gmail.com>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=yes, Size: 13879 bytes --]
This new field allows to specify in a search-path-specification that a
trailing separator should be added to the computed value of the environment
variable. A trailing separator sometimes has the meaning that the usual
builtin locations should be looked up as well as the ones explicitly
specified.
One use case is to specify the Emacs library paths using EMACSLOADPATH. This
allows to not embed the Emacs version in its search path specification, which
has been shown to cause issues when upgrading a profile or when defining
variant Emacs packages of different versions.
* guix/search-paths.scm (searh-path-specification): Add an APPEND-SEPARATOR?
field.
(search-path-specification->sexp): Adjust accordingly.
(sexp->search-path-specification): Likewise.
(evaluate-search-paths): Append a separator to the search path value when both
`separator' and `append-separator?' are #t. Document the new behavior.
* guix/scripts/environment.scm (create-environment): Adjust the logic used to
merge search-path values when creating an environment profile.
* guix/build/gnu-build-system.scm (set-paths): Adjust accordingly.
---
guix/build/gnu-build-system.scm | 12 ++++----
guix/build/profiles.scm | 13 ++++++---
guix/build/utils.scm | 12 ++++++--
guix/scripts/environment.scm | 11 ++++++--
guix/search-paths.scm | 49 +++++++++++++++++++++++----------
5 files changed, 69 insertions(+), 28 deletions(-)
diff --git a/guix/build/gnu-build-system.scm b/guix/build/gnu-build-system.scm
index af64b3b61f..1e4d8fecb4 100644
--- a/guix/build/gnu-build-system.scm
+++ b/guix/build/gnu-build-system.scm
@@ -2,7 +2,7 @@
;;; Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2018 Mark H Weaver <mhw@netris.org>
;;; Copyright © 2020 Brendan Tildesley <mail@brendan.scot>
-;;; Copyright © 2021 Maxim Cournoyer <maxim.cournoyer@gmail.com>
+;;; Copyright © 2020, 2021 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -100,23 +100,25 @@ there are none."
input-directories)))
(for-each (match-lambda
- ((env-var (files ...) separator type pattern)
+ ((env-var (files ...) separator type pattern append-sep)
(set-path-environment-variable env-var files
input-directories
#:separator separator
#:type type
- #:pattern pattern)))
+ #:pattern pattern
+ #:append-separator? append-sep)))
search-paths)
(when native-search-paths
;; Search paths for native inputs, when cross building.
(for-each (match-lambda
- ((env-var (files ...) separator type pattern)
+ ((env-var (files ...) separator type pattern append-sep)
(set-path-environment-variable env-var files
native-input-directories
#:separator separator
#:type type
- #:pattern pattern)))
+ #:pattern pattern
+ #:append-separator? append-sep)))
native-search-paths)))
(define* (install-locale #:key
diff --git a/guix/build/profiles.scm b/guix/build/profiles.scm
index a40c3f96de..83a4c4dd94 100644
--- a/guix/build/profiles.scm
+++ b/guix/build/profiles.scm
@@ -1,5 +1,6 @@
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2015, 2017, 2018, 2019, 2020, 2021 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -20,6 +21,7 @@
#:use-module (guix build union)
#:use-module (guix build utils)
#:use-module (guix search-paths)
+ #:use-module (srfi srfi-1)
#:use-module (srfi srfi-26)
#:use-module (ice-9 ftw)
#:use-module (ice-9 match)
@@ -51,10 +53,13 @@ user-friendly name of the profile is, for instance ~/.guix-profile rather than
((? string? separator)
(let ((items (string-tokenize* value separator)))
(cons search-path
- (string-join (map (lambda (str)
- (string-append replacement (crop str)))
- items)
- separator)))))))))
+ (string-join
+ (map (lambda (str)
+ (string-append replacement (crop str)))
+ ;; When APPEND-SEPARATOR? is #t, the trailing
+ ;; separator causes an empty string item. Remove it.
+ (remove string-null? items))
+ separator)))))))))
(define (write-environment-variable-definition port)
"Write the given environment variable definition to PORT."
diff --git a/guix/build/utils.scm b/guix/build/utils.scm
index 6c37021673..354be2e6e3 100644
--- a/guix/build/utils.scm
+++ b/guix/build/utils.scm
@@ -573,7 +573,8 @@ for under the directories designated by FILES. For example:
#:key
(separator ":")
(type 'directory)
- pattern)
+ pattern
+ (append-separator? #f))
"Look for each of FILES of the given TYPE (a symbol as returned by
'stat:type') in INPUT-DIRS. Set ENV-VAR to a SEPARATOR-separated path
accordingly. Example:
@@ -590,11 +591,16 @@ denoting file names to look for under the directories designated by FILES:
(list docbook-xml docbook-xsl)
#:type 'regular
#:pattern \"^catalog\\\\.xml$\")
-"
+
+When both SEPARATOR and APPEND-SEPARATOR? are true, a separator is appended to
+the value of the environment variable."
(let* ((path (search-path-as-list files input-dirs
#:type type
#:pattern pattern))
- (value (list->search-path-as-string path separator)))
+ (value (list->search-path-as-string path separator))
+ (value (if append-separator?
+ (string-append value separator)
+ value)))
(if (string-null? value)
(begin
;; Never set ENV-VAR to an empty string because often, the empty
diff --git a/guix/scripts/environment.scm b/guix/scripts/environment.scm
index 0360761683..c0e081a4bc 100644
--- a/guix/scripts/environment.scm
+++ b/guix/scripts/environment.scm
@@ -2,6 +2,7 @@
;;; Copyright © 2014, 2015, 2018 David Thompson <davet@gnu.org>
;;; Copyright © 2015, 2016, 2017, 2018, 2019, 2020, 2021 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2018 Mike Gerwitz <mtg@gnu.org>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -81,12 +82,18 @@ variables with additional search paths."
(when pure?
(purify-environment white-list))
(for-each (match-lambda
- ((($ <search-path-specification> variable _ separator) . value)
+ ((($ <search-path-specification> variable _ separator _
+ append-separator?) . value)
(let ((current (getenv variable)))
(setenv variable
(if (and current (not pure?))
(if separator
- (string-append value separator current)
+ (if append-separator?
+ ;; There is already a trailing separator
+ ;; at the end of value.
+ ;; (see: `evaluate-search-paths').
+ (string-append value current separator)
+ (string-append value separator current))
value)
value)))))
(profile-search-paths profile manifest))
diff --git a/guix/search-paths.scm b/guix/search-paths.scm
index 002e6342bb..d783a2815f 100644
--- a/guix/search-paths.scm
+++ b/guix/search-paths.scm
@@ -1,5 +1,6 @@
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2013, 2014, 2015, 2017, 2018 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2020 Maxim Cournoyer <maxim.cournoyer@gmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -30,6 +31,7 @@
search-path-specification-separator
search-path-specification-file-type
search-path-specification-file-pattern
+ search-path-specification-append-separator?
$PATH
@@ -54,14 +56,16 @@
(define-record-type* <search-path-specification>
search-path-specification make-search-path-specification
search-path-specification?
- (variable search-path-specification-variable) ;string
- (files search-path-specification-files) ;list of strings
- (separator search-path-specification-separator ;string | #f
- (default ":"))
- (file-type search-path-specification-file-type ;symbol
- (default 'directory))
- (file-pattern search-path-specification-file-pattern ;#f | string
- (default #f)))
+ (variable search-path-specification-variable) ;string
+ (files search-path-specification-files) ;list of strings
+ (separator search-path-specification-separator ;string | #f
+ (default ":"))
+ (file-type search-path-specification-file-type ;symbol
+ (default 'directory))
+ (file-pattern search-path-specification-file-pattern ;#f | string
+ (default #f))
+ (append-separator? search-path-specification-append-separator? ;#f | #t
+ (default #f)))
(define $PATH
;; The 'PATH' variable. This variable is a bit special: it is not attached
@@ -76,20 +80,32 @@ corresponds to the arguments expected by `set-path-environment-variable'."
;; Note that this sexp format is used both by build systems and in
;; (guix profiles), so think twice before you change it.
(match spec
- (($ <search-path-specification> variable files separator type pattern)
- `(,variable ,files ,separator ,type ,pattern))))
+ (($ <search-path-specification> variable files separator type pattern
+ append-separator?)
+ `(,variable ,files ,separator ,type ,pattern ,append-separator?))))
(define (sexp->search-path-specification sexp)
"Convert SEXP, which is as returned by 'search-path-specification->sexp', to
a <search-path-specification> object."
(match sexp
+ ((variable files separator type pattern append-separator?)
+ (search-path-specification
+ (variable variable)
+ (files files)
+ (separator separator)
+ (file-type type)
+ (file-pattern pattern)
+ (append-separator? append-separator?)))
+ ;; Previous search-path-specification form (without append-separator?
+ ;; might still be found in manifest files.
((variable files separator type pattern)
(search-path-specification
(variable variable)
(files files)
(separator separator)
(file-type type)
- (file-pattern pattern)))))
+ (file-pattern pattern)
+ (append-separator? #f)))))
(define-syntax-rule (with-null-error-port exp)
"Evaluate EXP with the error port pointing to the bit bucket."
@@ -131,7 +147,9 @@ like `string-tokenize', but SEPARATOR is a string."
"Evaluate SEARCH-PATHS, a list of search-path specifications, for
DIRECTORIES, a list of directory names, and return a list of
specification/value pairs. Use GETENV to determine the current settings and
-report only settings not already effective."
+report only settings not already effective. When the search path
+specification APPEND-SEPARATOR? and SEPARATOR fields are both set to true, a
+separator is appended to its computed value."
(define (search-path-definition spec)
(match spec
(($ <search-path-specification> variable files #f type pattern)
@@ -148,7 +166,7 @@ report only settings not already effective."
#f ;VARIABLE already set appropriately
(cons spec head))))))
(($ <search-path-specification> variable files separator
- type pattern)
+ type pattern append-separator?)
(let* ((values (or (and=> (getenv variable)
(cut string-tokenize* <> separator))
'()))
@@ -161,7 +179,10 @@ report only settings not already effective."
#:pattern pattern))))
(if (every (cut member <> values) path)
#f ;VARIABLE is already set appropriately
- (cons spec (string-join path separator)))))))
+ (let ((value (string-join path separator)))
+ (cons spec (if append-separator?
+ (string-append value separator)
+ value))))))))
(filter-map search-path-definition search-paths))
--
2.31.1
next prev parent reply other threads:[~2021-03-30 15:52 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-26 6:11 [bug#43627] [PATCH core-updates]: Add a 'append-separator?' field to the <search-path-specification> record Maxim Cournoyer
2020-09-26 6:14 ` [bug#43627] [PATCH core-updates 1/3] guix: Add an append-separator? " Maxim Cournoyer
2020-09-26 6:14 ` [bug#43627] [PATCH core-updates 2/3] gnu: emacs: Use the new append-separator? option to define its search path Maxim Cournoyer
2020-09-26 6:14 ` [bug#43627] [PATCH core-updates 3/3] Revert "emacs-build-system: Ensure the core libraries appear last in the load path." Maxim Cournoyer
2020-09-27 19:01 ` [bug#43627] [PATCH core-updates]: Add a 'append-separator?' field to the <search-path-specification> record Ludovic Courtès
2020-10-03 21:22 ` Maxim Cournoyer
2020-11-02 13:59 ` Ludovic Courtès
2020-11-08 5:49 ` Maxim Cournoyer
2021-03-30 15:51 ` Maxim Cournoyer [this message]
2021-03-30 15:51 ` [bug#43627] [PATCH core-updates v2 2/2] gnu: emacs: Use the new append-separator? option to define its search path Maxim Cournoyer
2021-04-10 20:42 ` [bug#43627] [PATCH core-updates v2 1/2] guix: Add an append-separator? field to the <search-path-specification> record Ludovic Courtès
2021-05-20 14:24 ` bug#43627: " Maxim Cournoyer
2021-03-30 18:41 ` [bug#43627] [PATCH] gnu: emacs: Wrap EMACSLOADPATH Leo Prikler
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
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210330155102.16610-1-maxim.cournoyer@gmail.com \
--to=maxim.cournoyer@gmail.com \
--cc=43627@debbugs.gnu.org \
--cc=ludo@gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).