From: Jan Nieuwenhuizen <janneke@gnu.org>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: 36563@debbugs.gnu.org
Subject: [bug#36563] [PATCH] guix: Add directory to channel.
Date: Sat, 13 Jul 2019 17:37:07 +0200 [thread overview]
Message-ID: <87ef2ukkt8.fsf@gnu.org> (raw)
In-Reply-To: <87lfx29qjq.fsf@gnu.org> ("Ludovic \=\?utf-8\?Q\?Court\=C3\=A8s\=22'\?\= \=\?utf-8\?Q\?s\?\= message of "Sat, 13 Jul 2019 12:28:41 +0200")
[-- Attachment #1: Type: text/plain, Size: 837 bytes --]
Ludovic Courtès writes:
Hi!
> That makes a lot of sense to me.
>
> I think that, instead of letting the user specify the right directory in
> ~/.config/guix/channels.scm, it should be the channel author that
> specifies the sub-directory.
>
> There’s already support for a ‘.guix-channel’ file so this is where this
> ‘directory’ thing could be added (actually there’s a FIXME in
> channels.scm about this particular use case :-)).
>
> WDYT?
Yes, I agree that this should be the first option to support. Attached
is a second attempt: I removed the FIXME and moved `directory' to
channel-metadata.
A downside could be that this could make a channel user dependent on
upstream to provide this `.guix-channel' file; probably best to worry
about that when the need arises :)
Greetings,
janneke
[-- Attachment #2: 0001-channels-Add-optional-directory-to-channel-metadata.patch --]
[-- Type: text/x-patch, Size: 8016 bytes --]
From 5d78a7eab391ea93c044d85736706b333c2dfee8 Mon Sep 17 00:00:00 2001
From: Jan Nieuwenhuizen <janneke@gnu.org>
Date: Sat, 13 Jul 2019 16:31:50 +0200
Subject: [PATCH] channels: Add optional directory to channel metadata.
* guix/channels.scm (<channel-metadata>): Add directory slot. Update users.
(read-channel-metadata-from-source): New function.
(standard-module-derivation): Use it.
* doc/guix.texi (Package Modules in a Subdirectory): New subsection.
---
doc/guix.texi | 23 ++++++++++++
guix/channels.scm | 93 ++++++++++++++++++++++++++---------------------
2 files changed, 75 insertions(+), 41 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index 5a8ad7ebda..8bc00a5350 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3921,6 +3921,29 @@ For the sake of reliability and maintainability, you should avoid dependencies
on channels that you don't control, and you should aim to keep the number of
dependencies to a minimum.
+@cindex subdirectory, channels
+@subsection Package Modules in a Subdirectory
+
+A developer may include a @file{guix} subdirectory in their upstream source
+that contains additional or modified Guix package descriptions. Typically,
+their toplevel @file{guix.scm} then uses those package definitions:
+
+@lisp
+(define %source-dir (dirname (current-filename)))
+(add-to-load-path (string-append %source-dir "/guix"))
+(use-modules @dots{})
+@dots{}
+@end lisp
+
+By adding a meta-data file @file{.guix-channel} that specifies the
+subdirectory that contains the Guix package descriptions it can be used
+directly as a channel:
+
+@lisp
+(channel
+ (directory "guix"))
+@end lisp
+
@subsection Replicating Guix
@cindex pinning, channels
diff --git a/guix/channels.scm b/guix/channels.scm
index e6bb9b891b..614639f091 100644
--- a/guix/channels.scm
+++ b/guix/channels.scm
@@ -1,6 +1,7 @@
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2018, 2019 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2018 Ricardo Wurmus <rekado@elephly.net>
+;;; Copyright © 2019 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -107,9 +108,10 @@
(checkout channel-instance-checkout))
(define-record-type <channel-metadata>
- (channel-metadata version dependencies)
+ (channel-metadata version directory dependencies)
channel-metadata?
(version channel-metadata-version)
+ (directory channel-metadata-directory)
(dependencies channel-metadata-dependencies))
(define (channel-reference channel)
@@ -119,18 +121,18 @@
(#f `(branch . ,(channel-branch channel)))
(commit `(commit . ,(channel-commit channel)))))
-(define (read-channel-metadata instance)
- "Return a channel-metadata record read from the channel INSTANCE's
-description file, or return #F if the channel instance does not include the
-file."
- (let* ((source (channel-instance-checkout instance))
- (meta-file (string-append source "/.guix-channel")))
+(define (read-channel-metadata-from-source source)
+ "Return a channel-metadata record read from channel's SOURCE/.guix-channel
+description file, or return #F if SOURCE/.guix-channel does not exist."
+ (let ((meta-file (string-append source "/.guix-channel")))
(and (file-exists? meta-file)
- (and-let* ((raw (call-with-input-file meta-file read))
- (version (and=> (assoc-ref raw 'version) first))
- (dependencies (or (assoc-ref raw 'dependencies) '())))
+ (let* ((raw (call-with-input-file meta-file read))
+ (version (and=> (assoc-ref raw 'version) first))
+ (directory (and=> (assoc-ref raw 'directory) first))
+ (dependencies (or (assoc-ref raw 'dependencies) '())))
(channel-metadata
version
+ directory
(map (lambda (item)
(let ((get (lambda* (key #:optional default)
(or (and=> (assoc-ref item key) first) default))))
@@ -144,12 +146,18 @@ file."
(commit (get 'commit))))))
dependencies))))))
+(define (read-channel-metadata instance)
+ "Return a channel-metadata record read from the channel INSTANCE's
+description file, or return #F if the channel instance does not include the
+file."
+ (read-channel-metadata-from-source (channel-instance-checkout instance)))
+
(define (channel-instance-dependencies instance)
"Return the list of channels that are declared as dependencies for the given
channel INSTANCE."
(match (read-channel-metadata instance)
(#f '())
- (($ <channel-metadata> version dependencies)
+ (($ <channel-metadata> version directory dependencies)
dependencies)))
(define* (latest-channel-instances store channels #:optional (previous-channels '()))
@@ -230,36 +238,39 @@ of COMMIT at URL. Use NAME as the channel name."
modules in SOURCE and that depend on DEPENDENCIES, a list of lowerable
objects. The assumption is that SOURCE contains package modules to be added
to '%package-module-path'."
- ;; FIXME: We should load, say SOURCE/.guix-channel.scm, which would allow
- ;; channel publishers to specify things such as the sub-directory where .scm
- ;; files live, files to exclude from the channel, preferred substitute URLs,
- ;; etc.
-
- (define build
- ;; This is code that we'll run in CORE, a Guix instance, with its own
- ;; modules and so on. That way, we make sure these modules are built for
- ;; the right Guile version, with the right dependencies, and that they get
- ;; to see the right (gnu packages …) modules.
- (with-extensions dependencies
- #~(begin
- (use-modules (guix build compile)
- (guix build utils)
- (srfi srfi-26))
-
- (define go
- (string-append #$output "/lib/guile/" (effective-version)
- "/site-ccache"))
- (define scm
- (string-append #$output "/share/guile/site/"
- (effective-version)))
-
- (compile-files #$source go
- (find-files #$source "\\.scm$"))
- (mkdir-p (dirname scm))
- (symlink #$source scm)
- scm)))
-
- (gexp->derivation-in-inferior name build core))
+
+ (let* ((metadata (read-channel-metadata-from-source source))
+ (directory (and=> metadata channel-metadata-directory)))
+
+ (define build
+ ;; This is code that we'll run in CORE, a Guix instance, with its own
+ ;; modules and so on. That way, we make sure these modules are built for
+ ;; the right Guile version, with the right dependencies, and that they get
+ ;; to see the right (gnu packages …) modules.
+ (with-extensions dependencies
+ #~(begin
+ (use-modules (guix build compile)
+ (guix build utils)
+ (srfi srfi-26))
+
+ (define go
+ (string-append #$output "/lib/guile/" (effective-version)
+ "/site-ccache"))
+ (define scm
+ (string-append #$output "/share/guile/site/"
+ (effective-version)))
+
+ (let* ((subdir (if #$directory
+ (string-append "/" #$directory)
+ ""))
+ (dir (string-append #$source subdir)))
+ (compile-files dir go (find-files dir "\\.scm$"))
+ (mkdir-p (dirname scm))
+ (symlink (string-append #$source subdir) scm))
+
+ scm)))
+
+ (gexp->derivation-in-inferior name build core)))
(define* (build-from-source name source
#:key core verbose? commit
--
2.21.0
[-- Attachment #3: Type: text/plain, Size: 154 bytes --]
--
Jan Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com
next prev parent reply other threads:[~2019-07-13 15:38 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-09 19:26 [bug#36563] [PATCH] guix: Add directory to channel Jan Nieuwenhuizen
2019-07-13 10:28 ` Ludovic Courtès
2019-07-13 15:37 ` Jan Nieuwenhuizen [this message]
2019-07-13 20:49 ` Ludovic Courtès
2019-07-13 23:09 ` bug#36563: " Jan Nieuwenhuizen
2019-07-14 13:24 ` [bug#36563] " Ludovic Courtès
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=87ef2ukkt8.fsf@gnu.org \
--to=janneke@gnu.org \
--cc=36563@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 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.