Change logs: usage of square brackets
Hello Guix! I wonder what is the proper usage of square brackets in change logs. According to https://www.gnu.org/prep/standards/standards.html#Change-Logs square brackets are used for conditional changes, the name of the condition is specified inside '[ ]'. However looking over the commit history I mostly see another usage of '[ ]' for specifying the name of a record field which content is being changed. Is it fine to use the name of a record field inside square brackets for changes that are only affected if the content of the record field is #t, like in https://issues.guix.gnu.org/70341#2 ? Best Regards, Nigko Yerden
What does it mean when patch disappears from qa.guix.gnu.org patches list?
Hello Guix! Recently the patch https://issues.guix.gnu.org/70341 has completely disappeared from https://qa.guix.gnu.org/patches? list of patches under consideration. I would like to know what does it mean? The patch was considered inappropriate and rejected? Or some kind of error in patch processing occurred? Regards, Nigko
Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Guix!,
Consider a minimal test git repository [1] created in line with Cookbook
recommendations [2]. It has the following file structure:
.
├── content
├── .guix-channel
├── guix.scm → .guix/modules/test-repo-package.scm
└── .guix
└── modules
└── test-repo-package.scm
Here 'content' is a text file. '.guix-channel' includes
-begin
(channel
(version 0)
(directory ".guix/modules"))
-end--
and '.guix/modules/test-repo-package.scm' provides a package definition:
-begin
(define-module (test-repo-package)
#:use-module (guix packages)
#:use-module (guix gexp)
#:use-module (guix utils)
#:use-module (guix git-download)
#:use-module (guix build-system copy)
#:use-module (guix licenses))
(define vcs-file?
;; Return true if the given file is under version control.
(or (git-predicate (dirname (dirname (current-source-directory
(const #t)))
(define-public test-repo
(package
(name "test-repo")
(version "1.0")
(source (local-file "../.." "test-repo-checkout"
#:recursive? #t
#:select? vcs-file?))
(build-system copy-build-system)
(arguments
(list #:install-plan #~'(("content" "share/"
(synopsis "Example: git repo as a package")
(description "Example: git repo as a package")
(home-page "https://example.com";)
(license gpl3+)))
test-repo
-end--
All what this package does is to install 'content' file to
'/gnu/store//share/content' path. 'guix build -f guix.scm' command works as
expected. However, if we add the repository to the list of channels in
~/.config/guix/channels.scm file:
-begin
(list
(channel
(name 'test-channel)
(url "https://gitlab.com/anigko/test-channel.git";)
(branch "main")))
-end--
and run 'guix pull', the command 'guix build test-repo' will fail with an error
message "No such file or directory 'content'" unless your GUILE_LOAD_PATH does
not include '~/.config/guix/current/share/guile/site/3.0/' path (this is the
path where a symlink to 'test-repo-package.scm' is installed by 'guix pull').
Normally GUILE_LOAD_PATH does include above-mentioned path. Indeed,
the GUIX System installer injects the following snippet
-begin
eval "$(guix package --search-paths \
-p $HOME/.config/guix/current \
-p $HOME/.guix-profile \
-p /run/current-system/profile)"
-end--
into '~/.bash_profile' file, setting many environment variables, and
GUILE_LOAD_PATH
in particular. In this case '(local-file "../.." "test-repo-checkout" ...)'
expression
is run from '~/.config/guix/current/share/guile/site/3.0/test-repo-package.scm'
file,
which is a symlink. But '(local-file "../.." ...)' does not follow this symlink,
and the 'source' field of 'test-repo' package is evaluated to
'~/.config/guix/current/share/guile/site/', which is wrong of course.
Here is a workaround for this behavior. From the definition of 'local-file' in
guix/gexp.scm one can deduce that the executed relevant code is:
(absolute-file-name "../.." (current-source-directory))
Here '(current-source-directory)' evaluates to
'~/.config/guix/current/share/guile/site/3.0/'.
However, if the symlink in '3.0/' directory would not target a file but another
directory,
say 'test-repo', containing a file 'package.scm' with the package definition,
then '(current-source-directory)' will follow the symlink, that is what we want.
The branch 'alt' of [1] provides a realization of the workaround:
.
├── content
├── .guix-channel
├── guix.scm → .guix/modules/test-repo/package.scm
└── .guix
└── modules
└── test-repo
└── package.scm
In comparison with 'test-repo-package.scm' file from 'main' branch, the
'package.scm'
file contains three modifications:
1.
(define-module (test-repo package)
2.
(define vcs-file?
;; Return true if the given file is under version control.
(or (git-predicate (dirname (dirname (dirname (current-source-directory)
(const #t)))
3.
(source (local-file "../../.." "test-repo-checkout"
#:recursive? #t
#:select? vcs-file?))
Thus defined repository ensures that 'test-repo' package is built without
errors on
systems with and without properly configured GUILE_LOAD_PATH.
Regards,
Nigko
[1] https://gitlab.com/anigko/test-channel.git
[2]
https://gui
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian, There is no grievance for anything. Sorry, if my message has such a tinge, it does not correspond to what was meant. Also I do not think that 'local-file' is doing something wrong. I suspect that introducing changes to such an ubiquitous procedure on such a minor subject is not necessary a good thing. What I meant is that recipe from cookbook does not work for Guix with GUILE_LOAD_PATH configured as in freshly installed Guix System, nothing more. Regards, Nigko pelzflorian (Florian Pelz) wrote: Hello Nigko. Do I understand correctly: Your grievance is the definition of `local-file', which for relative paths like "../.." does not follow symlinks to non-directory files, but should? And this is because current-source-directory returns the wrong path in a Guix channel? That is, `local-file' does not work correctly? And the problem is not how the cookbook is written? Could you create a bug report by writing a mail to bug-g...@gnu.org with this concrete issue, referencing this your mail to guix-devel: https://lists.gnu.org/archive/html/guix-devel/2024-08/msg00047.html Regards, Florian
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
pelzflorian (Florian Pelz) wrote: Your intention was just that others with the same use-case find your workaround in the mail archives. Then you did right. Not just this, but also that somebody may consider changing the cookbook. The guix-cookbook describes a (local-file "."), not "../..", You are looking at "7.2 Level 1: Building with Guix". See "7.2 Level 2: The Repository as a Channel", https://guix.gnu.org/en/cookbook/en/html_node/The-Repository-as-a-Channel.html, where there is a "../.." in the 'local-file' argument. I guess it needs no changes, or should we add a hint not to ..? I think it needs some changes, a warning at least. Also I think that keeping the package definition in additional nested directory like '.guix/modules/guile/package.scm' is not so bad and can replace a '.guix/modules/guile-package.scm' variant. Regards, Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian,
pelzflorian (Florian Pelz) wrote:
Nonsense; it must have worked; 7.7 Wrapping Up lists
https://git.savannah.gnu.org/cgit/guile.git/tree/.guix/modules/guile-package.scm?id=cd57379b3df636198d8cd8e76c1bfbc523762e79
as proof.
I clearly did something wrong. Sorry.
What’s the difference? Will try to compare.
For me pulling from this channel with subsequent
$ guix build guile@3.0.99-git
throws an error ("No such file or directory" "GUILE-VERSION"). However,
$ GUILE_LOAD_PATH= guix build guile@3.0.99-git
, which emulates system without [1] in Guile load path, works like a charm.
Thus, this repository behaves exactly as does the main branch of [2].
Perhaps many systems (e.g. Guix on foreign distributions) indeed does not
have [1] in Guile load path, and thus recipe from the Cookbook works for them.
Regards,
Nigko
[1] ~/.config/guix/current/share/guile/site/3.0/
[2] https://gitlab.com/anigko/test-channel.git
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Attila Lendvai, Thank you very much for your hints and references! Indeed I was puzzled by weird behavior of 'current-filename'. I wrote another alternative using '(module-filename (current-module))' based on https://issues.guix.gnu.org/55464 See alt2 branch of [1]. This variant does not need wrapping directory for the package file, and has the same file structure as the main branch of [1]. The variable (define package-dir (dirname (canonicalize-path (search-path %load-path (module-filename (current-module)) is bounded to the current directory of 'test-repo-package.scm', so the 'source' field of the package is (local-file (string-append package-dir "/../..") "test-repo-checkout" #:recursive? #t #:select? vcs-file?)) It seems to work even without macro wrapper. Regards, Nigko [1] https://gitlab.com/anigko/test-channel.git
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian!
Here is my version of your diff in attachment. With this patch
'guix build test-repo' works for the main branch of test-repo-channel,
i.e. it seems to solve one problem (I'm sure that 'guix build guile@3.0.99-git'
works as well for the guile channel, but didn't check this explicitly).
The other problem ('guix build -S test-repo') remains.
Regards,
Nigkodiff --git a/guix/utils.scm b/guix/utils.scm
index d8ce6ed886..8bd23097bf 100644
--- a/guix/utils.scm
+++ b/guix/utils.scm
@@ -1123,7 +1123,7 @@ (define absolute-dirname
;; If there are relative names in %LOAD-PATH, FILE can be relative and
;; needs to be canonicalized.
(if (string-prefix? "/" file)
- (dirname file)
+ (dirname (canonicalize-path file))
(canonicalize-path (dirname file)))
(define-syntax current-source-directory
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
On the second problem, I have found that while it is impossible to obtain test-repo source code via 'guix build -S test-repo', it can be retrieved programmatically from 'guix repl' REPL using this commands: (use-modules (test-repo-package) (guix packages) (guix gexp) (guix store)) (define src (package-source test-repo)) (run-with-store (open-connection) (lower-object src)) So, perhaps this problem is not so thorough. Regards, Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
'guix build --debug=5 -S test-repo' build logs shows that the problem
sits in 'guix-build' procedure from 'guix/scripts/build.scm'. 'drv' local
variable is initialized by '(options->derivations store opts)' at line 762
to a list '("/gnu/store/...-test-repo-checkout") containing store
path to the true test-repo checkout (i.e. what is desired to be the output
of 'guix build -S'), and not a file with .drv extension or derivation object.
But the subsequent code in 'guix-build' (calls to 'show-derivation-outputs' and
'derivation->output-paths' procedures) supposes that 'drv' is a list of
derivation objects or .drv files, which leads to an error.
Regards,
Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
pelzflorian (Florian Pelz) wrote: Could you send a patch about the `guix build' diff you debugged to guix-patc...@gnu.org? Preferrably you would drop the whole absolute-dirname’s `if' and canonicalize unconditionally, I guess. Make explicit in the docstring or in comments that symlinks are the reason. No. I view these patches of 'absolute-directory' as a demonstration that the current behavior of 'local-file' is connected just with not following symlinks, and not with something more complicated. The modification these patches adds to 'current-source-directory' (so it would follow symlinks) is worse than a hypothetical modification of 'local-file' because I suspect it would break even more people's code. Since cookbook's example refers to the Guile repo which does not work as a channel in Guix with the default GUILE_LOAD_PATH, maybe first we need to send a patch to Guile and then correct the cookbook accordingly? Regards, Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian,
I am sure you have nothing to apologize for. I have been
thinking about your suggestion to submit `absolute-dirname' patch. In the
Guix manual at the end of the section 6.7 Creating a channel [1] there is the
following statement about Guix policy on changing API, not to mention ABI:
"We, Guix developers, never change APIs gratuitously, but we do not
commit to freezing APIs either. When you maintain package definitions
outside Guix, we consider that the compatibility burden is on you."
So it is okay to change the behavior of some procedures if it will improve
Guix. But does changing the 'current-source-directory' to follow symlinks
improve Guix? This change would adjust Guix in accordance with the
documentation... What? Sounds very wrong. Should be the other way round,
shouldn't it? Maybe this change would make Guix API more powerful and
convenient? I assume that generally there is a practical necessity in
determining current source directory both with and without following
symlinks, 50/50. If I need to follow symlinks I still may use
'current-source-directory' not following symlinks this way:
(dirname
(canonicalize-path
(string-append (current-source-directory) (current-filename
But what should I do if I need not to follow symlinks and
'current-source-directory' follows symlinks. There is no simple way.
pelzflorian (Florian Pelz) wrote:
Would you send a patch doing implementing another option to
guix-patches? However, I would ask of you to send a patch to
guix-patches first and not to guile, since guile takes longer and
guix-patches would in my hope get others’ opinions involved.
Yes, I could. I wonder which alternative should I implement? One,
discussed earlier, adds an intermediate directory to the channel
relative path in the repository. This is simple, but somewhat
limited solution. Also changing directory structure may require
additional (and undesirable) modifications to other files in guile
repository.
Thanks to Attila there is another variant [2] which leaves the
directory structure intact:
(define checkout-dir
;; search %load-path for module filename,
;; follow symlink and return checkout directory
(string-append (dirname (canonicalize-path
(search-path %load-path
(module-filename (current-module)
"/../.."))
(define vcs-file?
;; Return true if the given file is under version control.
(or (git-predicate checkout-dir)
(const #t)))
(define-public guile
(package
...
(source (local-file checkout-dir "guile-checkout"
#:recursive? #t
#:select? vcs-file?))
What do you think?
Regards,
Nigko
[1] https://guix.gnu.org/en/manual/devel/en/html_node/Creating-a-Channel.html
[2]
https://gitlab.com/anigko/test-channel/-/blob/ef07ce6904c16533f0fc21fda74216ce0a38bafd/.guix/modules/test-repo-package.scm
('channel-dir' is a macro instead of a variable, but I don't see any
real benefits in using macro here)
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Nigko Yerden wrote: (dirname (canonicalize-path (string-append (current-source-directory) (current-filename Sorry, this expression for source directory is wrong. The correct one: (dirname (canonicalize-path (string-append (current-source-directory) "/" (basename (module-filename (current-module)) By the way this can also be used in the definition of 'checkout-dir', instead of direct call to '(search-path %load-path ...)'. Regards, Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
pelzflorian (Florian Pelz) wrote: But then again, the current current-source-directory already does follow symlinks in nearly all cases, even in configuration files Don't see it neither in the code nor in our examples. 'syntax-source' doesn't do this. The second branch of 'if' in 'absolute-dirname' bringing in 'canonicalize-path' is never executed in the examples (remember, the original patch didn't work because of this). but actually I do not know why `local-file', when calling `absolute-dirname', takes this case of `if'. Only the first branch of 'if' is executed in all practical cases I can imagine. Documenting this work-around is not enough; we would have to also document the rationale that local-file is weird and inconsistent, Why do you think we should do this in this section of cookbook? Isn't it a separate topic? because current-source-directory is weird and inconsistent It isn't. It simply does not follow symlinks by design. Why does current-source-directory use syntax-source? What can it use instead? Related syntaxes such as 'current-source-location' and 'current-filename' are all using 'syntax-source' under the hood. Regards, Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian,
pelzflorian (Florian Pelz) wrote:
While processing guile-package.scm,
(search-path %load-path "guile-package.scm")
returns an absolute path if and only if guile-package.scm is in the
load-path, like when using it from a channel. Then, your diff makes it
resolve symlinks.
That's right.
If the configuration or package file is not in the load-path,
guile-package.scm is returned, absolute-dirname’s other `if' branch
calls `canonicalize-path' on all but the basename and directory symlinks
already got resolved.
No, in this case 'search-path' returns #f. But if 'syntax-source' gives
absolute path, then 'current-source-directory' returns 'dirname' of this
path without calling 'absolute-dirname'.
Indeed with weird load-paths
GUILE_LOAD_PATH=${GUILE_LOAD_PATH}:/home/florian/src/home-config/configs guix
home reconfigure gnu.scm
;;;
("/gnu/store/nanvziq36krgh330yjhwpphcyfz5dyzm-guix-module-union/share/guile/site/3.0")
because syntax-source says filename is
"gnu.scm".
But not normally
GUILE_LOAD_PATH=${GUILE_LOAD_PATH} guix home reconfigure gnu.scm
;;; ("/home/florian/src/home-config/configs")
because syntax-source says filename is
"/home/florian/src/home-config/configs/gnu.scm".
This observation shows that 'current-source-directory' is really bad because
'syntax-source' is bad. Sometimes 'syntax-source' gives an absolute path, and
sometimes a relative one, and I don't understand under what conditions.
And '(module-filename (current-module))' does not seem to be better.
In my experiments it gives exactly the same filename as 'syntax-source'.
But this bad behavior of 'current-source-directory' is unrelated to symlinks and
'if' condition in 'absolute-dirname'. All Guile load paths I have seen before
are
absolute paths, and the second branch of 'if' is not executed for them.
Maybe we should leave 'absolute-dirname' alone, as well as
'current-source-directory',
and consider 'local-file' more closely.
Regards,
Nigko
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
Hello Florian,
pelzflorian (Florian Pelz) wrote:
Still, when would your diff break someone else’s code?
Instead of answering this tough question I decided to make another
patch (see attachment) which is guaranteed not to break another's code:
- The patch adds 'follow-symlinks?' argument to 'current-source-directory'
macro and 'absolute-dirname' procedure.
- In case of 'current-source-directory' the argument is optional and defaults
to #f. Thus new API is backward compatible with the old one.
- In case of 'absolute-dirname' the argument is mandatory, but this procedure
is internal to (guix utils) module and therefore the modification does not
change public API. The usage of 'absolute-dirname' inside this module
(only two occurrences) is corrected accordingly.
- 'local-file' macro from (guix gexp) uses 'current-source-directory' with
follow-symlinks? argument set to #t.
Regards,
Nigkodiff --git a/guix/gexp.scm b/guix/gexp.scm
index 74b4c49f90..5911ca4815 100644
--- a/guix/gexp.scm
+++ b/guix/gexp.scm
@@ -508,7 +508,7 @@ (define-syntax local-file
(string? (syntax->datum #'file))
;; FILE is a literal, so resolve it relative to the source directory.
#'(%local-file file
- (delay (absolute-file-name file
(current-source-directory)))
+ (delay (absolute-file-name file
(current-source-directory #t)))
rest ...))
((_ (assume-valid-file-name file) rest ...)
;; FILE is not a literal, so resolve it relative to the current
diff --git a/guix/utils.scm b/guix/utils.scm
index d8ce6ed886..b5fcf8cb28 100644
--- a/guix/utils.scm
+++ b/guix/utils.scm
@@ -1110,41 +1110,47 @@ (define (canonical-newline-port port)
(define (%guix-source-root-directory)
"Return the source root directory of the Guix found in %load-path."
- (dirname (absolute-dirname "guix/packages.scm")))
+ (dirname (absolute-dirname "guix/packages.scm" #f)))
(define absolute-dirname
;; Memoize to avoid repeated 'stat' storms from 'search-path'.
- (mlambda (file)
+ (mlambda (file follow-symlinks?)
"Return the absolute name of the directory containing FILE, or #f upon
-failure."
+failure. Follow symlinks if FOLLOW-SYMLINKS? is true."
(match (search-path %load-path file)
(#f #f)
((? string? file)
- ;; If there are relative names in %LOAD-PATH, FILE can be relative and
- ;; needs to be canonicalized.
- (if (string-prefix? "/" file)
- (dirname file)
- (canonicalize-path (dirname file)))
+ (if follow-symlinks?
+ (dirname (canonicalize-path file))
+ ;; If there are relative names in %LOAD-PATH, FILE can be relative
+ ;; and needs to be canonicalized.
+ (if (string-prefix? "/" file)
+ (dirname file)
+ (canonicalize-path (dirname file
(define-syntax current-source-directory
(lambda (s)
"Return the absolute name of the current directory, or #f if it could not
-be determined."
+be determined. Do not follow symlinks if FOLLOW-SYMLINKS? is false (the
default)."
+(define (source-directory follow-symlinks?)
+ (match (assq 'filename (or (syntax-source s) '()))
+ (('filename . (? string? file-name))
+;; If %FILE-PORT-NAME-CANONICALIZATION is 'relative, then FILE-NAME
+;; can be relative. In that case, we try to find out at run time
+;; the absolute file name by looking at %LOAD-PATH; doing this at
+;; run time rather than expansion time is necessary to allow files
+;; to be moved on the file system.
+(if (string-prefix? "/" file-name)
+(dirname (if follow-symlinks?
+ (canonicalize-path file-name)
+ file-name))
+#`(absolute-dirname #,file-name #,follow-symlinks?)))
+ ((or ('filename . #f) #f)
+;; raising an error would upset Geiser users
+#f)))
(syntax-case s ()
- ((_)
- (match (assq 'filename (or (syntax-source s) '()))
- (('filename . (? string? file-name))
- ;; If %FILE-PORT-NAME-CANONICALIZATION is 'relative, then FILE-NAME
- ;; can be relative. In that case, we try to find out at run time
- ;; the absolute file name by looking at %LOAD-PATH; doing this at
- ;; run time rather than expansion time is necessary to allow files
- ;; to be moved on the file system.
- (if (string-prefix? "/" file-name)
- (dirname file-name)
- #`(absolute-dirname #,file-name)))
- ((or ('filename . #f) #f)
- ;; raising an error would upset Geiser users
- #f))
+ ((_) (source-directory #f))
+ ((_ follow-symlinks?) (source-directory #'follow-symlinks?)
;;;
Re: Cookbook recipe from "The Repository as a Channel" section does not work for Guix with properly configured GUILE_LOAD_PATH
pelzflorian (Florian Pelz) wrote: Could you send this diff to guix-patc...@gnu.org? Here it is: https://issues.guix.gnu.org/72867 Regards, Nigko
