From unknown Sat Sep 20 10:49:28 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#53439 <53439@debbugs.gnu.org> To: bug#53439 <53439@debbugs.gnu.org> Subject: Status: [PATCH] doc: Document search paths. Reply-To: bug#53439 <53439@debbugs.gnu.org> Date: Sat, 20 Sep 2025 17:49:28 +0000 retitle 53439 [PATCH] doc: Document search paths. reassign 53439 guix-patches submitter 53439 Ludovic Court=C3=A8s severity 53439 normal tag 53439 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 05:48:23 2022 Received: (at submit) by debbugs.gnu.org; 22 Jan 2022 10:48:23 +0000 Received: from localhost ([127.0.0.1]:35790 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBDwU-0005fU-SQ for submit@debbugs.gnu.org; Sat, 22 Jan 2022 05:48:23 -0500 Received: from lists.gnu.org ([209.51.188.17]:37584) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBDwS-0005fL-Vr for submit@debbugs.gnu.org; Sat, 22 Jan 2022 05:48:21 -0500 Received: from eggs.gnu.org ([209.51.188.92]:42252) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nBDwP-0002Qi-AV for guix-patches@gnu.org; Sat, 22 Jan 2022 05:48:19 -0500 Received: from [2001:470:142:3::e] (port=49056 helo=fencepost.gnu.org) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nBDwL-0003Dx-Vn; Sat, 22 Jan 2022 05:48:15 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:Subject:To:From:in-reply-to: references; bh=fDvbvVhwWUelPeqLVS4qGhK7ugGBRAlCKOf/SomEpC4=; b=FJ1dg4eR4u9HHh i+cLE3yKABemYCpGvTuPrwtFQ6NULrvyFwBRc0Dx/Q/NwSKidQGuqAu7VaXbxBzJGdbsSg02Sqv+r IW5+6LdnImPwUKf9u4Pp/5avp3mLVwGWW0WYsrEfXhlyJgMd2jh9tcddjN8lZ+5RgIs26soe1odJc o3Y1pCxeUbRC1ACe/bKhtBLsb1gXxGxXLo3/lpTzdtLN5+8b4XR5VCpDBe4TdenoCopT1iVVfSQ/0 l1tCqeHXPWi5DS3URnaiuceVa28OhNUMS0k0dClAkxatpznQMsi2BELAmNVJe6QB9eZghfnfoj+AS bfvLJ7oHgpyBMQXjD3Tg==; Received: from 91-160-117-201.subs.proxad.net ([91.160.117.201]:60140 helo=gnu.org) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nBDwH-0000O4-TN; Sat, 22 Jan 2022 05:48:12 -0500 From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= To: guix-patches@gnu.org Subject: [PATCH] doc: Document search paths. Date: Sat, 22 Jan 2022 11:47:57 +0100 Message-Id: <20220122104757.1837-1-ludo@gnu.org> X-Mailer: git-send-email 2.34.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: submit Cc: =?UTF-8?q?Ludovic=20Court=C3=A8s?= X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) * doc/guix.texi (package Reference): Link to "Search Paths". (Build Phases): Mention 'set-paths' phase. (Search Paths): New node. --- doc/guix.texi | 184 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 183 insertions(+), 1 deletion(-) Hi! Here's a long overdue piece of documentation. Thoughts? Ludo'. diff --git a/doc/guix.texi b/doc/guix.texi index 912a8e3c5a..15d887576d 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -279,6 +279,7 @@ Programming Interface * Build Systems:: Specifying how packages are built. * Build Phases:: Phases of the build process of a package. * Build Utilities:: Helpers for your package definitions and more. +* Search Paths:: Declaring search path environment variables. * The Store:: Manipulating the package store. * Derivations:: Low-level interface to package derivations. * The Store Monad:: Purely functional interface to the store. @@ -6859,6 +6860,7 @@ package definitions. * Build Systems:: Specifying how packages are built. * Build Phases:: Phases of the build process of a package. * Build Utilities:: Helpers for your package definitions and more. +* Search Paths:: Declaring search path environment variables. * The Store:: Manipulating the package store. * Derivations:: Low-level interface to package derivations. * The Store Monad:: Purely functional interface to the store. @@ -7239,7 +7241,8 @@ Outputs}, for typical uses of additional outputs. @item @code{native-search-paths} (default: @code{'()}) @itemx @code{search-paths} (default: @code{'()}) A list of @code{search-path-specification} objects describing -search-path environment variables honored by the package. +search-path environment variables honored by the package. @xref{Search +Paths}, for more on search path specifications. @item @code{replacement} (default: @code{#f}) This must be either @code{#f} or a package object that will be used as a @@ -8900,6 +8903,10 @@ standard list of phases. For @code{gnu-build-system}, the main build phases are the following: @table @code +@item set-paths +Define search path environment variables for all the input packages, +including @env{PATH} (@pxref{Search Paths}). + @item unpack Unpack the source tarball, and change the current directory to the extracted source tree. If the source is actually a directory, copy it @@ -9393,6 +9400,181 @@ executable files to be installed: @c TODO: Add more examples. +@node Search Paths +@section Search Paths + +@cindex search path +Many programs and libraries look for input data in a @dfn{search path}, +a list of directories: shells like Bash look for executables in the +command search path, a C compiler looks for @file{.h} files in its +header search path, and the Python interpreter looks for @file{.py} +files in its search path, the spell checker has a search path for +dictionaries, and so on. + +Search paths can usually be defined or overridden @i{via} environment +variables (@pxref{Environment Variables,,, libc, The GNU C Library +Reference Manual}). For example, the search paths mentioned above can +be changed by defining the @env{PATH}, @env{C_INCLUDE_PATH}, +@env{PYTHONPATH} (or @env{GUIX_PYTHONPATH}), and @env{DICPATH} +environment variables---you know, all these something-PATH variables +that you need to get right or things ``won't be found''. + +You may have noticed from the command line that Guix ``knows'' which +search path environment variables should be defined, and how. When you +install packages in your default profile, the file +@file{~/.guix-profile/etc/profile} is created, which you can ``source'' +from the shell to set those variables. Likewise, if you ask +@command{guix shell} to create an environment containing Python and +NumPy, a Python library, and if you pass it the @option{--search-paths} +option, it will tell you about @env{PATH} and @env{GUIX_PYTHONPATH} +(@pxref{Invoking guix shell}): + +@example +$ guix shell python python-numpy --pure --search-paths +export PATH="/gnu/store/@dots{}-profile/bin" +export GUIX_PYTHONPATH="/gnu/store/@dots{}-profile/lib/python3.9/site-packages" +@end example + +When you omit @option{--search-paths}, it defines these environment +variables right away, such that Python can readily find NumPy: + +@example +$ guix shell python python-numpy -- python3 +Python 3.9.6 (default, Jan 1 1970, 00:00:01) +[GCC 10.3.0] on linux +Type "help", "copyright", "credits" or "license" for more information. +>>> import numpy +>>> numpy.version.version +'1.20.3' +@end example + +For this to work, the definition of the @code{python} package +@emph{declares} the search path it cares about and its associated +environment variable, @env{GUIX_PYTHONPATH}. It looks like this: + +@lisp +(package + (name "python") + (version "3.9.9") + ;; some fields omitted... + (native-search-paths + (list (search-path-specification + (variable "GUIX_PYTHONPATH") + (files (list "lib/python/3.9/site-packages")))))) +@end lisp + +What this @code{native-search-paths} field says is that, when the +@code{python} package is used, the @env{GUIX_PYTHONPATH} environment +variable must be defined to include all the +@file{lib/python/3.9/site-packages} sub-directories encountered in its +environment. (The @code{native-} bit means that, if we are in a +cross-compilation environment, only native inputs may be added to the +search path.) In the NumPy example above, the profile where +@code{python} appears contains exactly one such sub-directory, and +@env{GUIX_PYTHONPATH} is set to that. When there are several +@file{lib/python/3.9/site-packages}---this is the case in package build +environments---they are all added to @env{GUIX_PYTHONPATH}, separated by +colons (@code{:}). + +@quotation Note +Notice that @env{GUIX_PYTHONPATH} is specified as part of the definition +of the @code{python} package, and @emph{not} as part of that of +@code{python-numpy}. This is because this environment variable +``belongs'' to Python, not NumPy: Python actually reads the value of +that variable and honors it. + +Corollary: if you create a profile that does not contain @code{python}, +@code{GUIX_PYTHONPATH} will @emph{not} be defined, even if it contains +packages that provide @file{.py} files: + +@example +$ guix shell python-numpy --search-paths --pure +export PATH="/gnu/store/@dots{}-profile/bin" +@end example + +This makes a lot of sense if we look at this profile in isolation: no +software in this profile would read @env{GUIX_PYTHONPATH}. +@end quotation + +Of course, there are many variations on that theme: some packages honor +more than one search path, some use separators other than colon, some +accumulate several directories in their search path, and so on. A more +complex example is the search path of libxml2: the value of the +@env{XML_CATALOG_FILES} environment variable is space-separated, it must +contain a list of @file{catalog.xml} files (not directories), which are +to be found in @file{xml} sub-directories---nothing less. The search +path specification looks like this: + +@lisp +(define libxml2 + (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)))))) +@end lisp + +Worry not, search path specifications are usually not this tricky. + +The @code{(guix search-paths)} module defines the data type of search +path specifications and a number of helper procedures. Below is the +reference of search path specifications. + +@deftp {Data Type} search-path-specification +The data type for search path specifications. + +@table @asis +@item @code{variable} +The name of the environment variable for this search path (a string). + +@item @code{files} +The list of sub-directories (strings) that should be added to the search +path. + +@item @code{separator} (default: @code{":"}) +The string used to separate search path components. + +As a special case, a @code{separator} value of @code{#f} specifies a +``single-component search path''---in other words, a search path that +cannot contain more than one element. This is useful in some cases, +such as the @code{SSL_CERT_DIR} variable (honored by OpenSSL, cURL, and +a few other packages) or the @code{ASPELL_DICT_DIR} variable (honored by +the GNU Aspell spell checker), both of which must point to a single +directory. + +@item @code{file-type} (default: @code{'directory}) +The type of file being matched. + +In the libxml2 example above, we would match regular files. + +@item @code{file-pattern} (default: @code{#f}) +When true, this is 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. +@end table +@end deftp + +How do you turn search path specifications on one hand and a bunch of +directories on the other hand in a set of environment variable +definitions? That's the job of @code{evaluate-search-paths}. + +@deffn {Scheme Procedure} evaluate-search-paths @var{search-paths} @ + @var{directories} [@var{getenv}] +Evaluate @var{search-paths}, a list of search-path specifications, for +@var{directories}, a list of directory names, and return a list of +specification/value pairs. Use @var{getenv} to determine the current +settings and report only settings not already effective. +@end deffn + +The @code{(guix profiles)} provides a higher-level helper procedure, +@code{load-profile}, that sets the environment variables of a profile. + @node The Store @section The Store base-commit: ee6bf00b2d89f6acab55b7a82896d99e39c1229b -- 2.34.0 From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 07:50:06 2022 Received: (at 53439) by debbugs.gnu.org; 22 Jan 2022 12:50:06 +0000 Received: from localhost ([127.0.0.1]:35990 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBFqH-0001Ci-JV for submit@debbugs.gnu.org; Sat, 22 Jan 2022 07:50:06 -0500 Received: from albert.telenet-ops.be ([195.130.137.90]:52784) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBFqF-0001CY-CK for 53439@debbugs.gnu.org; Sat, 22 Jan 2022 07:50:03 -0500 Received: from ptr-bvsjgyhxw7psv60dyze.18120a2.ip6.access.telenet.be ([IPv6:2a02:1811:8c09:9d00:3c5f:2eff:feb0:ba5a]) by albert.telenet-ops.be with bizsmtp id loq12600H4UW6Th06oq1oN; Sat, 22 Jan 2022 13:50:02 +0100 Message-ID: Subject: Re: [bug#53439] [PATCH] doc: Document search paths. From: Maxime Devos To: Ludovic =?ISO-8859-1?Q?Court=E8s?= , 53439@debbugs.gnu.org Date: Sat, 22 Jan 2022 13:49:57 +0100 In-Reply-To: <20220122104757.1837-1-ludo@gnu.org> References: <20220122104757.1837-1-ludo@gnu.org> Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-2c+lyR73tneSkBueTurj" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1642855802; bh=qzSPhK8RJGltIR34DQsLAxkk8ks6IPY2GJgOjaJNKl4=; h=Subject:From:To:Date:In-Reply-To:References; b=ls/BCc8R5hgdgLL58t+MMku9puIkg4AWX+WCrgGCxKAAM9+lmma1kFQuSmQ+NX//z sAs2O6Zp7WbHRbNUWpuESvddMMSqoLEOD0XZb1+G71v5vn+PCn8nEoFyQRQLX6VXAW W0knNMQJQrCRtfglP8dwIZPLwqz3KG3u61Dj9PtaBLAropgrjYrt1acIV7+3SmJAsP WqoBxwYkC73rL5fe8QQsA69C60RCQxAWTf6KRRzAqejdvHj+wDM07Ylfm2NYIOzx96 mLhoED3hXRKVE1sfktBsLTETNUtUxxdXvC0hVo8n2KZn/RAAZYQpxbLt0geLgmEGRx g18b/gfUOjFPA== X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 53439 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.7 (-) --=-2c+lyR73tneSkBueTurj Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Ludovic Court=C3=A8s schreef op za 22-01-2022 om 11:47 [+0100]: > +What this @code{native-search-paths} field says is that, when the > +@code{python} package is used, the @env{GUIX_PYTHONPATH} environment > +variable must be defined to include all the > +@file{lib/python/3.9/site-packages} sub-directories encountered in its > +environment.=C2=A0 (The @code{native-} bit means that, if we are in a > +cross-compilation environment, only native inputs may be added to the > +search path.)=C2=A0 In the NumPy example above, the profile where This bit about inputs/native-inputs seems a little imprecise: (package (name "foobarify") [...] (inputs guile) (propagated-inputs ;; TODO: would be nice to unpropagate (list=C2=A0guile-foo guile-bar guile-ify)) ;; "foobarify" allows running arbitrary Guile scripts, ;; so allow the user to use arbitrary Guile libraries ;; from the environment in their scripts at will. (native-search-paths [GUILE_LOAD_PATH, GUILE_LOAD_COMPILED_PATH, ...])) $ [ guix cross-compile a virtual image with foobarify in the system profile] IIUC, guile-foo, guile-bar and guile-ify will be included in the GUILE_LOAD_PATH/GUILE_LOAD_COMPILED_PATH of the system profile, even though we are cross-compiling and they are 'inputs' and not 'native- inputs' of 'foobarify' ... Greetings, Maxime. --=-2c+lyR73tneSkBueTurj Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iI0EABYKADUWIQTB8z7iDFKP233XAR9J4+4iGRcl7gUCYev9dRccbWF4aW1lZGV2 b3NAdGVsZW5ldC5iZQAKCRBJ4+4iGRcl7pKFAP9Il9TOu8CNJNZ/Z5iIUMrAWgfu 88BHOp/lVKFPZE2zyQEA3jb+vFHDYlV1ZMK1PUuf8uVnH10xopgz5k57Mm/Jow4= =uTXz -----END PGP SIGNATURE----- --=-2c+lyR73tneSkBueTurj-- From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 07:54:47 2022 Received: (at 53439) by debbugs.gnu.org; 22 Jan 2022 12:54:47 +0000 Received: from localhost ([127.0.0.1]:35995 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBFup-0001JN-EK for submit@debbugs.gnu.org; Sat, 22 Jan 2022 07:54:47 -0500 Received: from michel.telenet-ops.be ([195.130.137.88]:49230) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBFuo-0001JF-5I for 53439@debbugs.gnu.org; Sat, 22 Jan 2022 07:54:46 -0500 Received: from ptr-bvsjgyhxw7psv60dyze.18120a2.ip6.access.telenet.be ([IPv6:2a02:1811:8c09:9d00:3c5f:2eff:feb0:ba5a]) by michel.telenet-ops.be with bizsmtp id louk2600L4UW6Th06oukEv; Sat, 22 Jan 2022 13:54:44 +0100 Message-ID: <0eb19f27f4c12a2a1fde2bb8ec09d03a44ef4d64.camel@telenet.be> Subject: Re: [bug#53439] [PATCH] doc: Document search paths. From: Maxime Devos To: Ludovic =?ISO-8859-1?Q?Court=E8s?= , 53439@debbugs.gnu.org Date: Sat, 22 Jan 2022 13:54:44 +0100 In-Reply-To: <20220122104757.1837-1-ludo@gnu.org> References: <20220122104757.1837-1-ludo@gnu.org> Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-lpuZz3tZibnzw3gointv" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1642856084; bh=p1SHFIcIlvJ6fgmcSwssgbWcbZkqVPE3e/zUQK/WkDo=; h=Subject:From:To:Date:In-Reply-To:References; b=I7SeOAgelD5gPwk3rJLFt0AqyzSlY2P+nh8oZIDpqHYIa/UjcUejWL62i1yq2fBXI 3AgSjshtVIz2RIVlX8RidBs7JE+iJ9QOvo2Z1ReaI+6FdLUmodteY5cv1ABM49ClLa y2C8tQzz49RTnhPxh0m72153D3y0XCY9hFcyy/WA5znWynPDAzPQOlILP9kPoPPPLh 0e9uExtYiloQMfRIlCB8dI0s3BsTJGEM96El7q4h1AQ5EqXUn0Fx1zA/7HCJUi9Qc1 yme3u9MW/IStfbwzEWNzoe2KwnlD6oaccOgka8ryS8QU1uy13zz9f8Zg6AYYoi+UQF RaIhuc/adkz7A== X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 53439 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.7 (-) --=-lpuZz3tZibnzw3gointv Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Ludovic Court=C3=A8s schreef op za 22-01-2022 om 11:47 [+0100]: > +``belongs'' to Python, not NumPy: Python actually reads the value of AFAIK Texinfo supports =E2=80=98curly=E2=80=99 quotes; there are a few inst= ances of =E2=80=98 and =E2=80=99 in doc/guix.texi. There does not appear to be any = need for transliteration. Greetings, Maxime. --=-lpuZz3tZibnzw3gointv Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iI0EABYKADUWIQTB8z7iDFKP233XAR9J4+4iGRcl7gUCYev+lBccbWF4aW1lZGV2 b3NAdGVsZW5ldC5iZQAKCRBJ4+4iGRcl7sOXAP9CMMKHKqjwao1pk80fy2AEIhXb jRi8gympBMA29T9+iwEAh+GOeSgD3u93ppH6R/GFefms0H/x/23mZNjh0tjT3A4= =WWj3 -----END PGP SIGNATURE----- --=-lpuZz3tZibnzw3gointv-- From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 08:00:22 2022 Received: (at 53439) by debbugs.gnu.org; 22 Jan 2022 13:00:22 +0000 Received: from localhost ([127.0.0.1]:36012 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBG0E-0001W1-2y for submit@debbugs.gnu.org; Sat, 22 Jan 2022 08:00:22 -0500 Received: from xavier.telenet-ops.be ([195.130.132.52]:48358) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBG0C-0001Vq-6f for 53439@debbugs.gnu.org; Sat, 22 Jan 2022 08:00:20 -0500 Received: from ptr-bvsjgyhxw7psv60dyze.18120a2.ip6.access.telenet.be ([IPv6:2a02:1811:8c09:9d00:3c5f:2eff:feb0:ba5a]) by xavier.telenet-ops.be with bizsmtp id lp0H2600X4UW6Th01p0J7V; Sat, 22 Jan 2022 14:00:18 +0100 Message-ID: Subject: Re: [bug#53439] [PATCH] doc: Document search paths. From: Maxime Devos To: Ludovic =?ISO-8859-1?Q?Court=E8s?= , 53439@debbugs.gnu.org Date: Sat, 22 Jan 2022 14:00:17 +0100 In-Reply-To: <20220122104757.1837-1-ludo@gnu.org> References: <20220122104757.1837-1-ludo@gnu.org> Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-r8JjjYJpkt7nGLL3v7nT" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1642856418; bh=zSZVOv/QJzpvOCtuv7kT2rClDk17kF/z5hZ03y6ULzI=; h=Subject:From:To:Date:In-Reply-To:References; b=hp/XwXYwInYpu7tI8tAGM75IERlybhSZqoQKj4tNUuMq9/hgla03wOSU+EcyrPdWE ldK1q9ih3tgIYnxonbWzNlGZsugcl4efR4gueqy+XF3i4CrS8w5NtiHUBccJxgAFRi 0/B3L4uHvjzi23zVCwFFz6LH2aJxQCyOxUMR5eXaNOaCRJIZpriJ0b9gkDdjLziXOI 7cP1A0+5vRcyykUH9xRztg5/x8HfBcRZTZirTboSd2d5KYv9cCBVVcgZ8UmiHJmia+ aRlcFyhVJVF1187ONUvzivK+hIIf5gEgA9vFqrxlqf7bCiUdKSO2dOKpNaDK/HN7Bn 845LzNIjH/Hkw== X-Spam-Score: -0.7 (/) X-Debbugs-Envelope-To: 53439 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.7 (-) --=-r8JjjYJpkt7nGLL3v7nT Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Ludovic Court=C3=A8s schreef op za 22-01-2022 om 11:47 [+0100]: > * doc/guix.texi (package Reference): Link to "Search Paths". > (Build Phases): Mention 'set-paths' phase. > (Search Paths): New node. > --- > =C2=A0doc/guix.texi | 184 +++++++++++++++++++++++++++++++++++++++++++++++= ++- > =C2=A01 file changed, 183 insertions(+), 1 deletion(-) >=20 > Hi! >=20 > Here's a long overdue piece of documentation. >=20 > Thoughts? >=20 > Ludo'. Aside from a remark about 'native-' vs. non-native it LGTM. Greetings, Maxime. --=-r8JjjYJpkt7nGLL3v7nT Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iI0EABYKADUWIQTB8z7iDFKP233XAR9J4+4iGRcl7gUCYev/4RccbWF4aW1lZGV2 b3NAdGVsZW5ldC5iZQAKCRBJ4+4iGRcl7sPHAP99q9XVUis3BvYEgd2Y3RKnpF2M f5YY/M1lDLZcCZYo4wEA9M+WAB76946gX/srBlcWP3MFO0PTJjAovfrpxmZygwQ= =ly0o -----END PGP SIGNATURE----- --=-r8JjjYJpkt7nGLL3v7nT-- From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 10:57:12 2022 Received: (at 53439) by debbugs.gnu.org; 22 Jan 2022 15:57:12 +0000 Received: from localhost ([127.0.0.1]:37704 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBIlM-0004q3-74 for submit@debbugs.gnu.org; Sat, 22 Jan 2022 10:57:12 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:55970) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBIlK-0004pl-E3 for 53439@debbugs.gnu.org; Sat, 22 Jan 2022 10:57:10 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 5403B4B8; Sat, 22 Jan 2022 16:57:03 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id G1_d047aRLgF; Sat, 22 Jan 2022 16:55:12 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id D3A3D1A0; Sat, 22 Jan 2022 16:55:00 +0100 (CET) From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Maxime Devos Subject: Re: bug#53439: [PATCH] doc: Document search paths. In-Reply-To: (Maxime Devos's message of "Sat, 22 Jan 2022 13:49:57 +0100") References: <20220122104757.1837-1-ludo@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) Date: Sat, 22 Jan 2022 16:54:54 +0100 Message-ID: <87lez722b5.fsf_-_@gnu.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / Authentication-Results: hera.aquilenet.fr; none X-Rspamd-Server: hera X-Rspamd-Queue-Id: 5403B4B8 X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; MIME_GOOD(-0.10)[text/plain]; RCPT_COUNT_TWO(0.00)[2]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[] X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) Hi Maxime, Maxime Devos skribis: > Ludovic Court=C3=A8s schreef op za 22-01-2022 om 11:47 [+0100]: >> +What this @code{native-search-paths} field says is that, when the >> +@code{python} package is used, the @env{GUIX_PYTHONPATH} environment >> +variable must be defined to include all the >> +@file{lib/python/3.9/site-packages} sub-directories encountered in its >> +environment.=C2=A0 (The @code{native-} bit means that, if we are in a >> +cross-compilation environment, only native inputs may be added to the >> +search path.)=C2=A0 In the NumPy example above, the profile where > > This bit about inputs/native-inputs seems a little imprecise: > > (package > (name "foobarify") > [...] > (inputs guile) > (propagated-inputs > ;; TODO: would be nice to unpropagate > (list=C2=A0guile-foo guile-bar guile-ify)) > ;; "foobarify" allows running arbitrary Guile scripts, > ;; so allow the user to use arbitrary Guile libraries > ;; from the environment in their scripts at will. > (native-search-paths > [GUILE_LOAD_PATH, GUILE_LOAD_COMPILED_PATH, ...])) > > $ [ guix cross-compile a virtual image with foobarify in the system > profile] > > IIUC, guile-foo, guile-bar and guile-ify will be included in the > GUILE_LOAD_PATH/GUILE_LOAD_COMPILED_PATH of the system profile, even > though we are cross-compiling and they are 'inputs' and not 'native- > inputs' of 'foobarify' ... I think the key bit in the parenthetical sentence you refer to is =E2=80=9C= if we are in a cross-compilation environment=E2=80=9D. If we are *not* cross-compiling, then both inputs and native inputs are included in the search path. Is that what you mean? I think we need a section about cross-compilation though, and that will allow us to clarify these things. I didn=E2=80=99t want to muddy the main message in cross-compilation considerations here. WDYT? Thanks for reviewing! Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Sat Jan 22 22:01:00 2022 Received: (at 53439) by debbugs.gnu.org; 23 Jan 2022 03:01:01 +0000 Received: from localhost ([127.0.0.1]:38329 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBT7k-0007F6-Gp for submit@debbugs.gnu.org; Sat, 22 Jan 2022 22:01:00 -0500 Received: from mail-qk1-f174.google.com ([209.85.222.174]:40734) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBT7i-0007Et-AK for 53439@debbugs.gnu.org; Sat, 22 Jan 2022 22:00:58 -0500 Received: by mail-qk1-f174.google.com with SMTP id z10so15424788qkf.7 for <53439@debbugs.gnu.org>; Sat, 22 Jan 2022 19:00:58 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=vGkhHM7FktlGUTUHQg1dB+Z+vWedRl5EsnbrqejqAOY=; b=Cwc3JknLQn3x340u9xF0eR8C3dUh4oJbnxYW6v3R/km94sG2UHvPzt6cVu7JbfFakB PtrvSE0fZwMGNB40VsaaKtg+BRc4doP/nHd1R+LU8x/JmZflPCJ0jZ976CNWnivs8XjX dKL898KrmExP/X2agJhLNM/KJpB1fDgDNJw0hTMRtANxV0qhPWzK55VdLKPlmlLzwaIj dkFgiT2QT2EUhGtOtZhfxbIoiCyiHcGrYGwu3uJQyeB3ndOgh8ah/uimZiXGjHlnoU0g 2hoDWtDbRdQkqiEVoBVQ0375UuWQJe4/1LIN3ZUXkhzqBq0xBpcQxRI35HNC0ZYMEuvU 1KEQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=vGkhHM7FktlGUTUHQg1dB+Z+vWedRl5EsnbrqejqAOY=; b=nqQA59q2ysuCE4PTqB8/jQ13rtQC0RAuF98DQjK+axI/YLUE+9QRaSAH6AEPcTEm3y Bc5nJ+cx4aetc+t4mDLDdEmTppcCLlHVoX4z/u4E0/EwSM8cKo7Jsp92f98qU0MQ8lB8 W3na9NkbKIlPbD/RqLGpC7QiQpstOcvM82XdDtfmSL3UKkT1bLz8AO0fkNtguCEyVk8w Ftjv/3ggr7qzjf8iocZNLjT+rEuWd2OPkHFgfJB5N5tQwyeSmHlrzH1TQn0UuKxWY6J2 fu3WoPP75j2BByiCXRGY+T24FNTHDnnkAjLQjjlECuY5uh3PLMkkd0PTEG4FiHXNUY7t sUAg== X-Gm-Message-State: AOAM531ROrDcvYOpiQM3WgPNtDYzHouCKOm/M/GblQo9A518l7gvOd2l JuQGXPXchBMCb9lMPlCkMnetfZULs+8= X-Google-Smtp-Source: ABdhPJx/czhCsvOHiq2qZ/yPe26+0hxMVKNXPSOWodWwah+AZt805rTVdOfcexcMhdnO6bx2x4QOwA== X-Received: by 2002:ae9:eb82:: with SMTP id b124mr1333504qkg.582.1642906852537; Sat, 22 Jan 2022 19:00:52 -0800 (PST) Received: from hurd (dsl-205-236-230-254.b2b2c.ca. [205.236.230.254]) by smtp.gmail.com with ESMTPSA id y2sm5233204qke.33.2022.01.22.19.00.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 22 Jan 2022 19:00:51 -0800 (PST) From: Maxim Cournoyer To: Ludovic =?utf-8?Q?Court=C3=A8s?= Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> Date: Sat, 22 Jan 2022 22:00:51 -0500 In-Reply-To: <20220122104757.1837-1-ludo@gnu.org> ("Ludovic =?utf-8?Q?Cour?= =?utf-8?Q?t=C3=A8s=22's?= message of "Sat, 22 Jan 2022 11:47:57 +0100") Message-ID: <87pmoj6tr0.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi Ludovic, Ludovic Court=C3=A8s writes: > * doc/guix.texi (package Reference): Link to "Search Paths". > (Build Phases): Mention 'set-paths' phase. > (Search Paths): New node. > --- > doc/guix.texi | 184 +++++++++++++++++++++++++++++++++++++++++++++++++- > 1 file changed, 183 insertions(+), 1 deletion(-) [...] > +@item @code{file-type} (default: @code{'directory}) > +The type of file being matched. > + > +In the libxml2 example above, we would match regular files. Here I am left wondering what other valid values (other than 'regular or 'directory) may be? I remember trying to find such answer, and it was not obvious (I can't remember where the answer lies in the Guile manual as I type this!). > +@item @code{file-pattern} (default: @code{#f}) > +When true, this is a regular expression specifying files to be > matched I'd replace "When true", which I find confusing, by 'Optional' or similar. > +@emph{within} the sub-directories specified by the @code{files} field. > + > +Again, the libxml2 example shows a situation where this is needed. > +@end table > +@end deftp > + > +How do you turn search path specifications on one hand and a bunch of > +directories on the other hand in a set of environment variable > +definitions? That's the job of @code{evaluate-search-paths}. > + > +@deffn {Scheme Procedure} evaluate-search-paths @var{search-paths} @ > + @var{directories} [@var{getenv}] > +Evaluate @var{search-paths}, a list of search-path specifications, for > +@var{directories}, a list of directory names, and return a list of > +specification/value pairs. Use @var{getenv} to determine the current > +settings and report only settings not already effective. > +@end deffn > + > +The @code{(guix profiles)} provides a higher-level helper procedure, > +@code{load-profile}, that sets the environment variables of a profile. > + > @node The Store > @section The Store This LGTM, taking the comments from Maxime into account. Thank you! Maxim From debbugs-submit-bounces@debbugs.gnu.org Sun Jan 23 16:40:17 2022 Received: (at 53439) by debbugs.gnu.org; 23 Jan 2022 21:40:17 +0000 Received: from localhost ([127.0.0.1]:41442 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBkav-0000fk-B0 for submit@debbugs.gnu.org; Sun, 23 Jan 2022 16:40:17 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:59960) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBkat-0000fW-18 for 53439@debbugs.gnu.org; Sun, 23 Jan 2022 16:40:15 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 2947616D; Sun, 23 Jan 2022 22:40:09 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id pW2Lo6u3LX-e; Sun, 23 Jan 2022 22:40:08 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id 03A594F; Sun, 23 Jan 2022 22:40:07 +0100 (CET) From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Maxim Cournoyer Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> <87pmoj6tr0.fsf@gmail.com> Date: Sun, 23 Jan 2022 22:40:07 +0100 In-Reply-To: <87pmoj6tr0.fsf@gmail.com> (Maxim Cournoyer's message of "Sat, 22 Jan 2022 22:00:51 -0500") Message-ID: <875yqayvuw.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / Authentication-Results: hera.aquilenet.fr; none X-Rspamd-Server: hera X-Rspamd-Queue-Id: 2947616D X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; FREEMAIL_ENVRCPT(0.00)[gmail.com]; TO_MATCH_ENVRCPT_ALL(0.00)[]; TAGGED_RCPT(0.00)[]; MIME_GOOD(-0.10)[text/plain]; RCPT_COUNT_TWO(0.00)[2]; FREEMAIL_TO(0.00)[gmail.com]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[] X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) Hi, Maxim Cournoyer skribis: > Ludovic Court=C3=A8s writes: > >> * doc/guix.texi (package Reference): Link to "Search Paths". >> (Build Phases): Mention 'set-paths' phase. >> (Search Paths): New node. >> --- >> doc/guix.texi | 184 +++++++++++++++++++++++++++++++++++++++++++++++++- >> 1 file changed, 183 insertions(+), 1 deletion(-) > > [...] > >> +@item @code{file-type} (default: @code{'directory}) >> +The type of file being matched. >> + >> +In the libxml2 example above, we would match regular files. > > Here I am left wondering what other valid values (other than 'regular or > 'directory) may be? I remember trying to find such answer, and it was > not obvious (I can't remember where the answer lies in the Guile manual > as I type this!). Oh right, these are the symbols returned by =E2=80=98stat:kind=E2=80=99. I= =E2=80=99ll clarify that. >> +@item @code{file-pattern} (default: @code{#f}) >> +When true, this is a regular expression specifying files to be >> matched > > I'd replace "When true", which I find confusing, by 'Optional' or > similar. =E2=80=9CWhen true=E2=80=9D is to be taken literally: if it has truth value= , in the Scheme sense. But =E2=80=9CUnless @code{#f}=E2=80=9D might be clearer? (=E2=80=9COptional=E2=80=9D sounds confusing to me because there has to be = a value, default or not.) Thanks for taking a look! Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Sun Jan 23 17:41:34 2022 Received: (at 53439-done) by debbugs.gnu.org; 23 Jan 2022 22:41:34 +0000 Received: from localhost ([127.0.0.1]:41510 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBlYD-0004Wc-RR for submit@debbugs.gnu.org; Sun, 23 Jan 2022 17:41:33 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:33032) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBlYD-0004WO-2M for 53439-done@debbugs.gnu.org; Sun, 23 Jan 2022 17:41:33 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 8FED517B; Sun, 23 Jan 2022 23:41:27 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 0lpvXLASVJTR; Sun, 23 Jan 2022 23:41:27 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id E35834F; Sun, 23 Jan 2022 23:41:26 +0100 (CET) From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Maxim Cournoyer , Maxime Devos Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> <87pmoj6tr0.fsf@gmail.com> <875yqayvuw.fsf_-_@gnu.org> Date: Sun, 23 Jan 2022 23:41:26 +0100 In-Reply-To: <875yqayvuw.fsf_-_@gnu.org> ("Ludovic =?utf-8?Q?Court=C3=A8s?= =?utf-8?Q?=22's?= message of "Sun, 23 Jan 2022 22:40:07 +0100") Message-ID: <87bl02xeg9.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / Authentication-Results: hera.aquilenet.fr; none X-Rspamd-Server: hera X-Rspamd-Queue-Id: 8FED517B X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[3]; TO_MATCH_ENVRCPT_ALL(0.00)[]; FREEMAIL_ENVRCPT(0.00)[gmail.com]; TAGGED_RCPT(0.00)[]; MIME_GOOD(-0.10)[text/plain]; TO_DN_SOME(0.00)[]; FREEMAIL_TO(0.00)[gmail.com,telenet.be]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[] X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 53439-done Cc: 53439-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) Pushed as 3878cf96183a27d63d374378d3044fd091231d0c with a couple of tweaks that you suggested, though now I realize I forgot the =E2=80=9Cwhen = true=E2=80=9D bit. Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 24 04:41:51 2022 Received: (at 53439) by debbugs.gnu.org; 24 Jan 2022 09:41:51 +0000 Received: from localhost ([127.0.0.1]:42108 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBvrD-0008JR-Mm for submit@debbugs.gnu.org; Mon, 24 Jan 2022 04:41:51 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:42290) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nBvrC-0008Iz-Bh for 53439@debbugs.gnu.org; Mon, 24 Jan 2022 04:41:50 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 74B393E4; Mon, 24 Jan 2022 10:41:44 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Xhu6YhUn4hrp; Mon, 24 Jan 2022 10:41:42 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id 819302FE; Mon, 24 Jan 2022 10:41:42 +0100 (CET) From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: 53439@debbugs.gnu.org Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <87bl02xeg9.fsf_-_@gnu.org> <20220122104757.1837-1-ludo@gnu.org> Date: Mon, 24 Jan 2022 10:41:41 +0100 In-Reply-To: (GNU bug Tracking System's message of "Sun, 23 Jan 2022 22:42:02 +0000") Message-ID: <878rv5wjvu.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / Authentication-Results: hera.aquilenet.fr; none X-Rspamd-Server: hera X-Rspamd-Queue-Id: 74B393E4 X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_THREE(0.00)[3]; FREEMAIL_ENVRCPT(0.00)[gmail.com]; TO_MATCH_ENVRCPT_ALL(0.00)[]; TAGGED_RCPT(0.00)[]; MIME_GOOD(-0.10)[text/plain]; TO_DN_SOME(0.00)[]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[]; FREEMAIL_CC(0.00)[telenet.be,gmail.com] X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 53439 Cc: Maxime Devos , Maxim Cournoyer X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) > Pushed as 3878cf96183a27d63d374378d3044fd091231d0c with a couple of > tweaks that you suggested, though now I realize I forgot the =E2=80=9Cwhe= n true=E2=80=9D > bit. Pushed a followup as a00dff3ac113722a709dbe97a727777b3739a5c1. Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Mon Jan 24 16:07:00 2022 Received: (at 53439) by debbugs.gnu.org; 24 Jan 2022 21:07:00 +0000 Received: from localhost ([127.0.0.1]:46060 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nC6YG-00073P-F5 for submit@debbugs.gnu.org; Mon, 24 Jan 2022 16:07:00 -0500 Received: from mail-qt1-f176.google.com ([209.85.160.176]:40909) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nC6YD-00073A-SW for 53439@debbugs.gnu.org; Mon, 24 Jan 2022 16:06:59 -0500 Received: by mail-qt1-f176.google.com with SMTP id v5so6167524qto.7 for <53439@debbugs.gnu.org>; Mon, 24 Jan 2022 13:06:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=XqJ8WT+U/PqvvLRcgXsHdGQpl/fWIVndoGTn3Ok1KCg=; b=io8nOT40hteQ/JD3tskVX+n/9HybmVXSzh7ke+8JRgKh6KIxxn7QE5KitthNGOEEtm Wp1NX0tUcoDcRVvBAL+u3FNrC4tIev5kqh9KT7dsUShKSlLU+NW4Ih0YE9iHDyHBKp4w rUbidGwmvnDrd/Ab6ENsnOmqmRqs/6KpL3KQ1OzHBRP8wmHazyD1SwoeBc8XwyWnvLVK IPZC76RB0D77EnLy8WOGqKhjZjwHyb8t+6cbdzLH7m24UOYzyM10wUglayLwhGyh4ENF VP9Vvs0b31gdzk1udpYax8uU5rbb+Ef+i7coPPBOyl/xIbthE4rC2EdyBLgxZ+wAYTub tq7A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=XqJ8WT+U/PqvvLRcgXsHdGQpl/fWIVndoGTn3Ok1KCg=; b=7RiZuHtPkoxXU9TcxKxpeFWETSqQpQd4klyHlKByK0EOuLlZ/2Jp5jAEKdtyJFjHGI nHwM7fZGaPiZSa/ynSjKJ3TJHaXu0KVJ0OKUSYZrWxfBFkld7IbrZB5RyBf9LdMenfc+ Hd9LzVP5HqzPMORs3cw8hJClgh4prUzeDDJ5yKGAanUcRuVfHlI7YJ6PVlMpeUpsH87W EGRnjnHrC8+yPjrUf23gFD2DmVZDozMzJOjkZcpAaYk6v9qitZIUnw9D00hRlbInZleX KMKA4Np7HoDdQ7kLLN1x9D32h6/gQPaNaUyjES7dx486MWoZMzDI5OD4eCfir1Q/Xr07 cbaw== X-Gm-Message-State: AOAM532A9xuEHK5dVlSaaFmU6/rLIdrqJqRxnOQcG/pVBQ0DWwqyT83c nqU5Tnlimmp5FARZCh79Q+JZGifh79k= X-Google-Smtp-Source: ABdhPJzc/DBCGgIdpbq1fxid+jmQppwuvAJtAA2PM3S7H6nIHOsR33WFlaqr+cx9algr249U35NFRA== X-Received: by 2002:a05:622a:208:: with SMTP id b8mr14019705qtx.657.1643058411985; Mon, 24 Jan 2022 13:06:51 -0800 (PST) Received: from hurd (dsl-205-233-125-146.b2b2c.ca. [205.233.125.146]) by smtp.gmail.com with ESMTPSA id x11sm2191192qkm.108.2022.01.24.13.06.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Jan 2022 13:06:51 -0800 (PST) From: Maxim Cournoyer To: Ludovic =?utf-8?Q?Court=C3=A8s?= Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> <87pmoj6tr0.fsf@gmail.com> <875yqayvuw.fsf_-_@gnu.org> Date: Mon, 24 Jan 2022 16:06:50 -0500 In-Reply-To: <875yqayvuw.fsf_-_@gnu.org> ("Ludovic =?utf-8?Q?Court=C3=A8s?= =?utf-8?Q?=22's?= message of "Sun, 23 Jan 2022 22:40:07 +0100") Message-ID: <87r18w6dxx.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hi Ludovic, Ludovic Court=C3=A8s writes: > Hi, > > Maxim Cournoyer skribis: > >> Ludovic Court=C3=A8s writes: >> >>> * doc/guix.texi (package Reference): Link to "Search Paths". >>> (Build Phases): Mention 'set-paths' phase. >>> (Search Paths): New node. >>> --- >>> doc/guix.texi | 184 +++++++++++++++++++++++++++++++++++++++++++++++++- >>> 1 file changed, 183 insertions(+), 1 deletion(-) >> >> [...] >> >>> +@item @code{file-type} (default: @code{'directory}) >>> +The type of file being matched. >>> + >>> +In the libxml2 example above, we would match regular files. >> >> Here I am left wondering what other valid values (other than 'regular or >> 'directory) may be? I remember trying to find such answer, and it was >> not obvious (I can't remember where the answer lies in the Guile manual >> as I type this!). > > Oh right, these are the symbols returned by =E2=80=98stat:kind=E2=80=99. = I=E2=80=99ll clarify > that. > >>> +@item @code{file-pattern} (default: @code{#f}) >>> +When true, this is a regular expression specifying files to be >>> matched >> >> I'd replace "When true", which I find confusing, by 'Optional' or >> similar. > > =E2=80=9CWhen true=E2=80=9D is to be taken literally: if it has truth val= ue, in the > Scheme sense. But =E2=80=9CUnless @code{#f}=E2=80=9D might be clearer? > > (=E2=80=9COptional=E2=80=9D sounds confusing to me because there has to b= e a value, > default or not.) >From the user point of view, specifying it is really optional though. Yours is more correct but perhaps confusing to those not knowing a string is truthy in Guile (and I'd argue it takes attention away from what is important here). What I had on mind was: "An optional regular expression to specify which files should be matched, based on their base name." or similar. (optional because if you don't specify it defaults to #f, which means "no added behavior"). I've used that approach when describing optional fields of service configurations in the past. My 2 cents, and either way I'm fine with it :-) Thanks, Maxim From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 25 08:06:57 2022 Received: (at 53439) by debbugs.gnu.org; 25 Jan 2022 13:06:57 +0000 Received: from localhost ([127.0.0.1]:47318 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCLXF-00009h-Ao for submit@debbugs.gnu.org; Tue, 25 Jan 2022 08:06:57 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:55388) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCLXC-00009U-Fl for 53439@debbugs.gnu.org; Tue, 25 Jan 2022 08:06:55 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 96BF5A4; Tue, 25 Jan 2022 14:06:48 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id m75HtthaVc_y; Tue, 25 Jan 2022 14:06:48 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id A30259D; Tue, 25 Jan 2022 14:06:47 +0100 (CET) From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Maxim Cournoyer Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> <87pmoj6tr0.fsf@gmail.com> <875yqayvuw.fsf_-_@gnu.org> <87r18w6dxx.fsf@gmail.com> X-URL: http://www.fdn.fr/~lcourtes/ X-Revolutionary-Date: 6 =?utf-8?Q?Pluvi=C3=B4se?= an 230 de la =?utf-8?Q?R?= =?utf-8?Q?=C3=A9volution?= X-PGP-Key-ID: 0x090B11993D9AEBB5 X-PGP-Key: http://www.fdn.fr/~lcourtes/ludovic.asc X-PGP-Fingerprint: 3CE4 6455 8A84 FDC6 9DB4 0CFB 090B 1199 3D9A EBB5 X-OS: x86_64-pc-linux-gnu Date: Tue, 25 Jan 2022 14:06:47 +0100 In-Reply-To: <87r18w6dxx.fsf@gmail.com> (Maxim Cournoyer's message of "Mon, 24 Jan 2022 16:06:50 -0500") Message-ID: <87a6fknevs.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / Authentication-Results: hera.aquilenet.fr; none X-Rspamd-Server: hera X-Rspamd-Queue-Id: 96BF5A4 X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; FREEMAIL_ENVRCPT(0.00)[gmail.com]; TAGGED_RCPT(0.00)[]; MIME_GOOD(-0.10)[text/plain]; RCPT_COUNT_TWO(0.00)[2]; FREEMAIL_TO(0.00)[gmail.com]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[] X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) Hello, Maxim Cournoyer skribis: > Ludovic Court=C3=A8s writes: [...] >> =E2=80=9CWhen true=E2=80=9D is to be taken literally: if it has truth va= lue, in the >> Scheme sense. But =E2=80=9CUnless @code{#f}=E2=80=9D might be clearer? >> >> (=E2=80=9COptional=E2=80=9D sounds confusing to me because there has to = be a value, >> default or not.) > > From the user point of view, specifying it is really optional though. Yes, that=E2=80=99s what the =E2=80=9C(default: @code{#f})=E2=80=9D bit con= veys. > Yours is more correct but perhaps confusing to those not knowing a > string is truthy in Guile (and I'd argue it takes attention away from > what is important here). > > What I had on mind was: > > "An optional regular expression to specify which files should be > matched, based on their base name." or similar. > > (optional because if you don't specify it defaults to #f, which means > "no added behavior"). > > I've used that approach when describing optional fields of service > configurations in the past. OK. The way I see it, that it=E2=80=99s optional is already implied by the= fact it has a default value. Regarding the truth value, I ended up in a00dff3ac113722a709dbe97a727777b3739a5c1 with hopefully clearer wording: @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. I guess we=E2=80=99re nitpicking :-) but I like to have, on one hand, text = in natural language with examples that conveys ideas in an informal way, and on the other hand, reference material (@deftp, @deffn, etc.) that=E2=80= =99s rigorous. Ludo=E2=80=99. From debbugs-submit-bounces@debbugs.gnu.org Tue Jan 25 20:50:52 2022 Received: (at 53439) by debbugs.gnu.org; 26 Jan 2022 01:50:52 +0000 Received: from localhost ([127.0.0.1]:50586 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCXSW-0001P8-9G for submit@debbugs.gnu.org; Tue, 25 Jan 2022 20:50:52 -0500 Received: from mail-qt1-f170.google.com ([209.85.160.170]:45813) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCXST-0001Oq-9a for 53439@debbugs.gnu.org; Tue, 25 Jan 2022 20:50:51 -0500 Received: by mail-qt1-f170.google.com with SMTP id o3so6290731qtm.12 for <53439@debbugs.gnu.org>; Tue, 25 Jan 2022 17:50:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version:content-transfer-encoding; bh=aoSFL7Yu+S9hnd9JEyuf6cX1mtOCgqidpdA5ikfIY28=; b=fjUCqxH8Sn1KL3uuD0Pdr4JoUadnDPw0dKlc/lCNkeTzcJAsMj2rShKyf45NfSNuMz E7LAjMJuf/JLy/zZ1UvwV2DEKRF1inl/W6S+lKl2RpjHvjdsPBmOXfFduM9K/UD8rTbJ MHcVCjSitydKVS5U4oVYf5P1TzM+ug/UPqlrbFYCjoAJhLmogx+9DiOMFCEvg2inmbE4 ZcBQFDLlUaWq6wibj0um1vQuheFfkFpQdbf9DM62FEyOOxD8iyVeX59ILo3e6UHobufr 7E+9k1xrNokJJq7bzNioVKz58MdWen6oYe7MccaPD/KS7Hhvf1SnZeKtHPEmqyliXyBu k4Ow== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version:content-transfer-encoding; bh=aoSFL7Yu+S9hnd9JEyuf6cX1mtOCgqidpdA5ikfIY28=; b=6QraUfQZpU9IWXQAU/n2DixDB3u7VyTZeR5t74OKOw2g1E23nDct3FpQxT7DU0kCs/ 4XWuH3kcPhzX3EU6/GJRaqSBRzD9A0lutQJyaeLQwjAoy8FeTzpA/1bdvYXPc9cG1yfX oO1LQLrnfK+HuZ/Rh9wRhKcyt+lqErytC+Lr3Lso/az76bcZkJ6EWQ2C/NXLkHm3aAkY CqPD1LBvK4vftUpKCpTa//meRg34EIarbaMkW82mhBJ4eG2yymqX7RsxH/0n7zdqEz3c q2roua9VratsitOy9q1embVp86utyZqvYFiCmh3cPOtgq2FBxgsygweKGO9mWnfQHsFv RYcQ== X-Gm-Message-State: AOAM532ga66gXX9CYGkqKOtxdq2asHVOz9RIvuNJGiV71LMy+8vHDItB QIW+IFt4DjRK4C5ABcKNUwLlyogH/yU= X-Google-Smtp-Source: ABdhPJzYtzy+yOBOynKk8Je1e2s4iO/dyD5jFF2qDePH/pRiGK2ggjUPo/+V8qpfFPb0TCcIOtvu2Q== X-Received: by 2002:ac8:5f96:: with SMTP id j22mr7888496qta.334.1643161843383; Tue, 25 Jan 2022 17:50:43 -0800 (PST) Received: from hurd (dsl-205-233-124-191.b2b2c.ca. [205.233.124.191]) by smtp.gmail.com with ESMTPSA id b9sm9740009qkj.10.2022.01.25.17.50.42 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Jan 2022 17:50:43 -0800 (PST) From: Maxim Cournoyer To: Ludovic =?utf-8?Q?Court=C3=A8s?= Subject: Re: bug#53439: [PATCH] doc: Document search paths. References: <20220122104757.1837-1-ludo@gnu.org> <87pmoj6tr0.fsf@gmail.com> <875yqayvuw.fsf_-_@gnu.org> <87r18w6dxx.fsf@gmail.com> <87a6fknevs.fsf@gnu.org> Date: Tue, 25 Jan 2022 20:50:42 -0500 In-Reply-To: <87a6fknevs.fsf@gnu.org> ("Ludovic =?utf-8?Q?Court=C3=A8s=22'?= =?utf-8?Q?s?= message of "Tue, 25 Jan 2022 14:06:47 +0100") Message-ID: <875yq7464t.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 53439 Cc: 53439@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Hello! [...] > Regarding the truth value, I ended up in > a00dff3ac113722a709dbe97a727777b3739a5c1 with hopefully clearer wording: > > @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. That's explicit and avoid the issue altogether, I like it! > I guess we=E2=80=99re nitpicking :-) but I like to have, on one hand, tex= t in > natural language with examples that conveys ideas in an informal way, > and on the other hand, reference material (@deftp, @deffn, etc.) that=E2= =80=99s > rigorous. I see; that makes sense. Thanks for taking the time to adjust the final result! Maxim From unknown Sat Sep 20 10:49:28 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 23 Feb 2022 12:24:06 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator