From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id qAbiCi3FW1/OfgAA0tVLHw (envelope-from ) for ; Fri, 11 Sep 2020 18:42:53 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id eOI2BS3FW19yWgAAB5/wlQ (envelope-from ) for ; Fri, 11 Sep 2020 18:42:53 +0000 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 884A4940215 for ; Fri, 11 Sep 2020 18:42:52 +0000 (UTC) Received: from localhost ([::1]:48586 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1kGo0Z-0003YR-J0 for larch@yhetil.org; Fri, 11 Sep 2020 14:42:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60738) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1kGo0A-0003Ob-Lu for guix-devel@gnu.org; Fri, 11 Sep 2020 14:42:26 -0400 Received: from mail-qv1-xf2e.google.com ([2607:f8b0:4864:20::f2e]:46773) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1kGo08-0002Se-IC for guix-devel@gnu.org; Fri, 11 Sep 2020 14:42:26 -0400 Received: by mail-qv1-xf2e.google.com with SMTP id di5so5692750qvb.13 for ; Fri, 11 Sep 2020 11:42:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=/QQv3A4aWzFkDs0JiWWx2G9eXyNleQa6DvxORoyaVpU=; b=pSyCA6CNJmySxR59bgyGbmlnqCRcA73moyF4O6+89SwIrNLfUhI2w6MdcWFB114B2d /0XC1SPCfOnGEv8uG9VpSVa80PPhqs0RGElLAIOR7aU4piq29l+zKjN6hUOM9/PQNs2h LkJmFAlVsS3/gpjYcjGQBBLwAE7icxZDoC/o2IMQWQ9kA5RIJ7KTI2kc1CG/fxDbtaFU 7xVQEWmS+nDuMu9ei4OJgYtAywNAtSlVAixZ24YnFH5ujgNnpGPunVeu/T6TOS2h40AI QhaqMmTX7Py+7rGmCChr5gzK9Bh2+of0RsAfUfQbCqBdGros/I9YEqMhM4bFtONQbrMx /JTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=/QQv3A4aWzFkDs0JiWWx2G9eXyNleQa6DvxORoyaVpU=; b=sEo/Bk8z60WB5AvtX5bp3T9kAElfX24Cll5aQuuaWHD0Fk7oaZb1KEilHEvTl0LMAv 0bqj++G8c+S3YEFgDLX8idecEz3AhBa2puAtQUN8DUKqtuLNoLrHFKI+66kyTfODsZpz I1Pi1zfcylh472eaiTbQXncEEuyeozSYDvxcZ4HV8gWkgWLqFG+oqYtNIn3ZWDwDWn9X ExNpKiCGO1rTn+2BRKlK8rFzC7qK6nX2c1KLqwxVb4/f89znh3Lszzuz/1rBbrrVHWVf wS2GaC13vIhajQtZj1aliNFsL5mdN0jUtHp2IYJq+/tHuDae0ykbegGpdX5I4QeIlv8t SbNQ== X-Gm-Message-State: AOAM530txfDXR65TDeFyiLLb5KHRRVQuDNr6K5LFTYOD3FZPXhg9Ktgr 3H7JVfRu0VuRDZPhtX2f0Z/u/Xj/Bbp/9qDYpbQ= X-Google-Smtp-Source: ABdhPJxQKGn5O364LeQIY4ih/ieFjhL6TyQUnep+IKff/bTFCXMc5sP76zU2+k3eugYQfvFgST7O1yBYV4vk3DyoXno= X-Received: by 2002:a0c:db8d:: with SMTP id m13mr3375771qvk.88.1599849743211; Fri, 11 Sep 2020 11:42:23 -0700 (PDT) MIME-Version: 1.0 References: <87h7ssx07p.fsf@gmail.com> <87lfhkj4hr.fsf@netris.org> <20200908072249.GA1469@jurong> <87lfhg6umj.fsf@gmail.com> In-Reply-To: <87lfhg6umj.fsf@gmail.com> From: zimoun Date: Fri, 11 Sep 2020 20:42:12 +0200 Message-ID: Subject: Re: What should "guix build --source" produce? (was Re: Dependency cycle issues when using a Gexp-based snippet) To: Maxim Cournoyer Content-Type: text/plain; charset="UTF-8" Received-SPF: pass client-ip=2607:f8b0:4864:20::f2e; envelope-from=zimon.toutoune@gmail.com; helo=mail-qv1-xf2e.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: guix-devel Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Scanner: scn0 Authentication-Results: aspmx1.migadu.com; dkim=fail (rsa verify failed) header.d=gmail.com header.s=20161025 header.b=pSyCA6CN; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of guix-devel-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-devel-bounces@gnu.org X-Spam-Score: 0.09 X-TUID: YHn+WSOuRYb3 Hi, On Fri, 11 Sep 2020 at 20:22, Maxim Cournoyer wrote: > Yes, this sounds like it! How about the following section, to help > contributors decide between the two? > > --8<---------------cut here---------------start------------->8--- > 1 file changed, 14 insertions(+) > doc/contributing.texi | 14 ++++++++++++++ > > modified doc/contributing.texi > @@ -369,6 +369,7 @@ needed is to review and apply the patch. > * Package Naming:: What's in a name? > * Version Numbers:: When the name is not enough. > * Synopses and Descriptions:: Helping users find the right package. > +* Snippets versus Phases:: Whether to use a snippet, or a build phase. > * Python Modules:: A touch of British comedy. > * Perl Modules:: Little pearls. > * Java Packages:: Coffee break. > @@ -599,6 +600,19 @@ Gettext}): > for the X11 resize-and-rotate (RandR) extension. @dots{}") > @end example > > +@node Snippets versus phases > +@subsection Snippets versus phases > + > +@cindex snippets, when to use > +The boundary between using an origin snippet versus a build phase to > +modify the sources of a package can be elusive. Origin snippets are > +typically used to remove unnecessary files such as bundled libraries, > +nonfree sources, or to apply simple substitutions. The source derived > +from an origin should produce a source that can be used to build the > +package on any system that the upstream package supports (i.e., act as > +the corresponding source). In particular, origin patches or snippets > +must not embed store items in the sources; such patching should rather > +be done using build phases. > > @node Python Modules > @subsection Python Modules > --8<---------------cut here---------------end--------------->8--- It helps. :-) And the origin snippet: http://guix.gnu.org/manual/devel/en/guix.html#origin-Reference could be cross-linked to the subsection above. Thank you for the insightful remark. All the best, simon