From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id 4MVNKiIV72GBbQAAgWs5BA (envelope-from ) for ; Mon, 24 Jan 2022 22:07:46 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id cJK3JyIV72GGfgEA9RJhRA (envelope-from ) for ; Mon, 24 Jan 2022 22:07:46 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 42273ACFF for ; Mon, 24 Jan 2022 22:07:46 +0100 (CET) Received: from localhost ([::1]:50002 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nC6Yz-0000lH-2h for larch@yhetil.org; Mon, 24 Jan 2022 16:07:45 -0500 Received: from eggs.gnu.org ([209.51.188.92]:50490) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nC6YI-0008GV-3A for guix-patches@gnu.org; Mon, 24 Jan 2022 16:07:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:53157) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nC6YH-0002at-PF for guix-patches@gnu.org; Mon, 24 Jan 2022 16:07:01 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nC6YH-00073e-JM for guix-patches@gnu.org; Mon, 24 Jan 2022 16:07:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53439] [PATCH] doc: Document search paths. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 24 Jan 2022 21:07:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 53439 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Ludovic =?UTF-8?Q?Court=C3=A8s?= Cc: 53439@debbugs.gnu.org Received: via spool by 53439-submit@debbugs.gnu.org id=B53439.164305842027124 (code B ref 53439); Mon, 24 Jan 2022 21:07:01 +0000 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 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?="'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-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+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1643058466; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=XqJ8WT+U/PqvvLRcgXsHdGQpl/fWIVndoGTn3Ok1KCg=; b=jmH2I4CTDvnhtsrIV9np1O4dFzkMoPVYn2Y73o6ec7qywZ8tqsF7jKjZL/YE4JK0YxdXjB ZZZPWx+VPntUpTSAkqM8S5ko2kn4W4sk2PudF1JnL3UK+DYJJ5+MEDk8MACHHuSn3mPRiW EL9fbWgZTnY6a0kv76auaj0XRofu24sWs+ovonWv1wV5gE0sDOa1A59rnlDyF7CYXzs1f2 LTI5/KM7JEwDrP1794j+rGUn2rJHEJWniMxkWqRihtGnlq1shOj3okUVqyvQG86uPTU0+V hCrqa/06HaRx0Jv+Mjz1uvLdh2lVq0vYDWGiI6cR/9aAD2KNjrMP4DepVNWKfA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1643058466; a=rsa-sha256; cv=none; b=lm4Scz0rddzYIrWZly1T0TzOTR74SSZjI72BD3U4kdI60tL5VqlO/INondoESAe4BAYIZQ 0GbSiRKaAZCNOhaQsbAwFDjnwCDf3m8RRKoDyt8iW/bSqvI4NJ+K8JNOJzOeMjImdZDUed FuFWSkbgslSK9QbWVy69PqtEEnxaYWQkmw3vaZesXsdMIXZuapLt2iMkpEUGD5oqenTvnr bl+PVzOTlO6ZvUSBHh2uGHZlulElTACKG0mP82Xt8w8qmf87NK/2lLL3tt5HVQtq3CeyOv Wm+74PlOwnwiKx/O6To5/fMNX0QUP4Kq20S9xIjPLEX3+WUanTc7ymHAjnH/+A== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=io8nOT40; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -2.03 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20210112 header.b=io8nOT40; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 42273ACFF X-Spam-Score: -2.03 X-Migadu-Scanner: scn1.migadu.com X-TUID: XSpW65yZVNmi 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