From b07c028a84c9fb4cbf6d78f7c589cbae77b4aebc Mon Sep 17 00:00:00 2001 From: Maxim Cournoyer Date: Thu, 1 Feb 2024 12:51:07 -0500 Subject: gnu: base: Add cautionary comments for canonical-package, %final-inputs usage. * gnu/packages/base.scm (canonical-package, %final-inputs): Add comments. Change-Id: I8b2f5802127dbde169850a7931a64fb5eb503b7c --- gnu/packages/base.scm | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'gnu/packages') diff --git a/gnu/packages/base.scm b/gnu/packages/base.scm index 42d585de9b..0c4a9a08ed 100644 --- a/gnu/packages/base.scm +++ b/gnu/packages/base.scm @@ -84,6 +84,10 @@ libc-utf8-locales-for-target make-ld-wrapper libiconv-if-needed + + ;; Beware: the following should not be used the top level to avoid + ;; introducing circular module dependencies. + canonical-package %final-inputs)) ;;; Commentary: @@ -1778,12 +1782,18 @@ package needs iconv ,@(libiconv-if-needed) should be added." (list libiconv) '())) -(define-public (canonical-package package) +;;; Beware: canonical-package should not be used at the top level, to avoid +;;; eagerly resolving (gnu packages commencement), which would introduce +;;; circular module dependencies. +(define (canonical-package package) ;; Avoid circular dependency by lazily resolving 'commencement'. (let* ((iface (resolve-interface '(gnu packages commencement))) (proc (module-ref iface 'canonical-package))) (proc package))) +;;; Beware: %final-inputs should not be used at the top level, to avoid +;;; eagerly resolving (gnu packages commencement), which would introduce +;;; circular module dependencies. (define* (%final-inputs #:optional (system (%current-system))) "Return the list of \"final inputs\"." ;; Avoid circular dependency by lazily resolving 'commencement'. -- cgit v1.2.3