From patchwork Mon Oct 9 20:05:50 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bruno Victal X-Patchwork-Id: 54641 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 70A7C27BBEA; Mon, 9 Oct 2023 21:08:28 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 8427627BBEB for ; Mon, 9 Oct 2023 21:08:22 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qpwXi-0005rj-Cx; Mon, 09 Oct 2023 16:07:54 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qpwXb-0005oM-Ds for guix-patches@gnu.org; Mon, 09 Oct 2023 16:07:47 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qpwXa-0007rq-DG; Mon, 09 Oct 2023 16:07:46 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qpwXr-0002Sm-Fj; Mon, 09 Oct 2023 16:08:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#65479] [PATCH core-updates v3 02/63] search-paths: Add $XML_CATALOG_FILES and $SGML_CATALOG_FILES. Resent-From: Bruno Victal Original-Sender: "Debbugs-submit" Resent-CC: guix@cbaines.net, dev@jpoiret.xyz, ludo@gnu.org, othacehe@gnu.org, rekado@elephly.net, zimon.toutoune@gmail.com, me@tobias.gr, guix-patches@gnu.org Resent-Date: Mon, 09 Oct 2023 20:08:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 65479 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 65479@debbugs.gnu.org Cc: Bruno Victal , Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Ricardo Wurmus , Simon Tournier , Tobias Geerinckx-Rice X-Debbugs-Original-Xcc: Christopher Baines , Josselin Poiret , Ludovic =?utf-8?q?Court=C3=A8s?= , Mathieu Othacehe , Ricardo Wurmus , Simon Tournier , Tobias Geerinckx-Rice Received: via spool by 65479-submit@debbugs.gnu.org id=B65479.16968820589188 (code B ref 65479); Mon, 09 Oct 2023 20:08:03 +0000 Received: (at 65479) by debbugs.gnu.org; 9 Oct 2023 20:07:38 +0000 Received: from localhost ([127.0.0.1]:33253 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qpwXR-0002O2-I2 for submit@debbugs.gnu.org; Mon, 09 Oct 2023 16:07:38 -0400 Received: from smtpm3.myservices.hosting ([185.26.105.234]:59254) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qpwXP-0002Nh-3N for 65479@debbugs.gnu.org; Mon, 09 Oct 2023 16:07:35 -0400 Received: from mail1.netim.hosting (unknown [185.26.106.173]) by smtpm3.myservices.hosting (Postfix) with ESMTP id BDA2220FDE for <65479@debbugs.gnu.org>; Mon, 9 Oct 2023 22:07:13 +0200 (CEST) Received: from localhost (localhost [127.0.0.1]) by mail1.netim.hosting (Postfix) with ESMTP id 268448009C; Mon, 9 Oct 2023 22:07:13 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at mail1.netim.hosting Received: from mail1.netim.hosting ([127.0.0.1]) by localhost (mail1-2.netim.hosting [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id SHTXuYDg5h-m; Mon, 9 Oct 2023 22:07:12 +0200 (CEST) Received: from guix-nuc.home.arpa (unknown [10.192.1.83]) (Authenticated sender: lumen@makinata.eu) by mail1.netim.hosting (Postfix) with ESMTPSA id 792768009D; Mon, 9 Oct 2023 22:07:11 +0200 (CEST) From: Bruno Victal Date: Mon, 9 Oct 2023 21:05:50 +0100 Message-ID: <6cb2e86fb52e37573db40d9de435f64f48cac90b.1696881354.git.mirai@makinata.eu> X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches These variables are used by some packages for XML/SGML catalog lookups. * guix/search-paths ($XML_CATALOG_FILES, $SGML_CATALOG_FILES): New variable, extracted from … * gnu/packages/xml.scm (libxml2, opensp)[native-search-paths]: … here. Refer to the variables from (guix search-paths) respectively. * gnu/packages/perl.scm (perl-app-xml-docbook-builder)[native-search-paths]: Use $XML_CATALOG_FILES. * doc/guix.texi (Search Paths): Update documentation to reflect changes. --- doc/guix.texi | 33 ++++++++++++++++++++------------- gnu/packages/perl.scm | 7 +------ gnu/packages/xml.scm | 19 +++---------------- guix/search-paths.scm | 25 +++++++++++++++++++++++++ 4 files changed, 49 insertions(+), 35 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 8c5697589f..4afe1af6c0 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -11144,17 +11144,14 @@ Search Paths to be found in @file{xml} sub-directories---nothing less. The search path specification looks like this: +@c This is defined at (guix search-paths) as $XML_CATALOG_FILES. @lisp -(package - (name "libxml2") - ;; some fields omitted - (native-search-paths - (list (search-path-specification - (variable "XML_CATALOG_FILES") - (separator " ") - (files '("xml")) - (file-pattern "^catalog\\.xml$") - (file-type 'regular))))) +(search-path-specification + (variable "XML_CATALOG_FILES") + (separator " ") + (files '("xml")) + (file-pattern "^catalog\\.xml$") + (file-type 'regular)) @end lisp Worry not, search path specifications are usually not this tricky. @@ -11190,15 +11187,16 @@ Search Paths though it can be any symbol returned by @code{stat:type} (@pxref{File System, @code{stat},, guile, GNU Guile Reference Manual}). -In the libxml2 example above, we would match regular files; in the -Python example, we would match directories. +In the @env{XML_CATALOG_FILES} example above, we would match regular +files; in the Python example, we would match directories. @item @code{file-pattern} (default: @code{#f}) This must be either @code{#f} or a regular expression specifying files to be matched @emph{within} the sub-directories specified by the @code{files} field. -Again, the libxml2 example shows a situation where this is needed. +Again, the @env{XML_CATALOG_FILES} example shows a situation where this +is needed. @end table @end deftp @@ -11206,6 +11204,15 @@ Search Paths To reduce duplications, some of them are pre-defined in @code{(guix search-paths)}. +@defvar $SGML_CATALOG_FILES +@defvarx $XML_CATALOG_FILES +These two search paths indicate where the +@url{https://www.oasis-open.org/specs/a401.htm,TR9401 catalog}@footnote{ +Alternatively known as SGML catalog.} or +@url{https://www.oasis-open.org/committees/download.php/14809/xml-catalogs.html, +XML catalog} files can be found. +@end defvar + @defvar $SSL_CERT_DIR @defvarx $SSL_CERT_FILE These two search paths indicate where X.509 certificates can be found diff --git a/gnu/packages/perl.scm b/gnu/packages/perl.scm index 8b82c272fc..267a35e560 100644 --- a/gnu/packages/perl.scm +++ b/gnu/packages/perl.scm @@ -601,12 +601,7 @@ (define-public perl-app-xml-docbook-builder (list perl-class-xsaccessor perl-test-trap)) (native-search-paths ;; xsltproc's search paths, to avoid propagating libxslt. - (list (search-path-specification - (variable "XML_CATALOG_FILES") - (separator " ") - (files '("xml")) - (file-pattern "^catalog\\.xml$") - (file-type 'regular)))) + (list $XML_CATALOG_FILES)) (home-page "https://www.shlomifish.org/open-source/projects/docmake/") (synopsis "Translate DocBook/XML documentation into other file formats") (description diff --git a/gnu/packages/xml.scm b/gnu/packages/xml.scm index cc26e2fa67..baf024820c 100644 --- a/gnu/packages/xml.scm +++ b/gnu/packages/xml.scm @@ -83,6 +83,7 @@ (define-module (gnu packages xml) #:use-module (guix build-system python) #:use-module (guix deprecation) #:use-module (guix utils) + #:use-module (guix search-paths) #:use-module (gnu packages linux) #:use-module (gnu packages pkg-config)) @@ -225,14 +226,7 @@ (define-public libxml2 (inputs (list xz)) (propagated-inputs (list zlib)) ; libxml2.la says '-lz'. (native-inputs (list perl)) - ;; $XML_CATALOG_FILES lists 'catalog.xml' files found in under the 'xml' - ;; sub-directory of any given package. - (native-search-paths (list (search-path-specification - (variable "XML_CATALOG_FILES") - (separator " ") - (files '("xml")) - (file-pattern "^catalog\\.xml$") - (file-type 'regular)))) + (native-search-paths (list $XML_CATALOG_FILES)) (search-paths native-search-paths) (description "Libxml2 is the XML C parser and toolkit developed for the Gnome @@ -1806,14 +1800,7 @@ (define-public opensp (("^\tOSGMLNORM=`echo osgmlnorm\\|sed '\\$\\(transform\\)'`\\\\") "\tOSGMLNORM=`echo osgmlnorm|sed '$(transform)'`") (("^\t\\$\\(SHELL\\)\n") ""))))))) - ;; $SGML_CATALOG_FILES lists 'catalog' or 'CATALOG' or '*.cat' files found - ;; under the 'sgml' sub-directory of any given package. - (native-search-paths (list (search-path-specification - (variable "SGML_CATALOG_FILES") - (separator ":") - (files '("sgml")) - (file-pattern "^catalog$|^CATALOG$|^.*\\.cat$") - (file-type 'regular)))) + (native-search-paths (list $SGML_CATALOG_FILES)) (home-page "https://openjade.sourceforge.net/") (synopsis "Suite of SGML/XML processing tools") (description "OpenSP is an object-oriented toolkit for SGML parsing and diff --git a/guix/search-paths.scm b/guix/search-paths.scm index 5375fae34b..d325e57989 100644 --- a/guix/search-paths.scm +++ b/guix/search-paths.scm @@ -42,6 +42,8 @@ (define-module (guix search-paths) $SSL_CERT_DIR $SSL_CERT_FILE $TZDIR + $SGML_CATALOG_FILES + $XML_CATALOG_FILES %gcc-search-paths @@ -154,6 +156,29 @@ (define $TZDIR (files '("share/zoneinfo")) (separator #f))) ;single entry +;; Some packages (notably libxml2) make use of 'XML_CATALOG_FILES' +;; and 'SGML_CATALOG_FILES' for remapping URI references or public/system +;; identifiers to other URI references. +(define $SGML_CATALOG_FILES + ;; $SGML_CATALOG_FILES lists 'catalog' or 'CATALOG' or '*.cat' files found + ;; under the 'sgml' sub-directory of any given package. + (search-path-specification + (variable "SGML_CATALOG_FILES") + (separator ":") + (files '("sgml")) + (file-pattern "^catalog$|^CATALOG$|^.*\\.cat$") + (file-type 'regular))) + +(define $XML_CATALOG_FILES + ;; $XML_CATALOG_FILES lists 'catalog.xml' files found in under the 'xml' + ;; sub-directory of any given package. + (search-path-specification + (variable "XML_CATALOG_FILES") + (separator " ") + (files '("xml")) + (file-pattern "^catalog\\.xml$") + (file-type 'regular))) + (define (search-path-specification->sexp spec) "Return an sexp representing SPEC, a . The sexp corresponds to the arguments expected by `set-path-environment-variable'."