From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id oIFKL6ex8mLETQAAbAwnHQ (envelope-from ) for ; Tue, 09 Aug 2022 21:12:39 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id kPRgLqex8mLAfgAAG6o9tA (envelope-from ) for ; Tue, 09 Aug 2022 21:12:39 +0200 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 6ECC520BC9 for ; Tue, 9 Aug 2022 21:12:39 +0200 (CEST) Received: from localhost ([::1]:51852 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oLUec-0006wi-Dr for larch@yhetil.org; Tue, 09 Aug 2022 15:12:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42062) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oLUb5-0002uX-9r for guix-devel@gnu.org; Tue, 09 Aug 2022 15:09:02 -0400 Received: from mail-ej1-x642.google.com ([2a00:1450:4864:20::642]:43716) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oLUb3-0004mB-LW; Tue, 09 Aug 2022 15:08:59 -0400 Received: by mail-ej1-x642.google.com with SMTP id gb36so23829096ejc.10; Tue, 09 Aug 2022 12:08:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:subject:from:to:cc:date:in-reply-to:references :user-agent:mime-version:content-transfer-encoding; bh=QXbKG9abYQ37Z/KA14jOFXRxTi8Qk221HL+jpBemOss=; b=qd3d9fSroQ423ks2fkvTclB1y1J9sazWTdjUlzqOI3+0B0v5Dveb9qs3C3h2N31ztL SpMglYEbfET4qRJRSiFRRT/Nn9o/eWWS6OlEFIb5Zu3G8ACtht+7B5Xpwr7hVEAPRPl4 T3nV3J2P2Z6KAxuN1SRUN32eCMDgucM4LxbIYO6HONrBP57f9t5V4zRZULicA5ozP7/Q a6HGohArI/JjANSg4fdwdiv465se8looFSSwn9LkT08DfHS1Rglrs9j3ZSRKcpQjPxZT D66p7jft9wRSR3Jmq7gdU7sDCJgrkH23DC3btYrH46xTvGDjZVclfV4IcvHtnWvjFIgj 8lkg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:subject:from:to:cc:date:in-reply-to :references:user-agent:mime-version:content-transfer-encoding; bh=QXbKG9abYQ37Z/KA14jOFXRxTi8Qk221HL+jpBemOss=; b=6h+/oQEX6fxJJpeOd/rmV2KHvnzdAa1XQrBPF3PUQRZsaw2wg8Cq8LK0m9fF9yjOvY JoL3wUTItjftJ7R/MCqChSuKAHqKzNJ6qv+8wzwMb+SfaVgXeg3m62lsT638DKhH6/RV BCIAdBEWuIoGSPrPIib6LW/rSx7rP71y4Ricxv0EeKmUE4hO2uJpC5wMyhsW12nhTx9m jHIrNICXpLRsLrKkY/raGBhAMSLHoN8XDyEepCwsYZBlKaeDsQr7DxBPRddy+a3WEkzn ox/uPgu5vIGe8aYBNFZH7vnbVAvN7Vh/X0mrzuGcVLAK5QliTLbNJaTTp+tPwUQ0JZM6 3CyQ== X-Gm-Message-State: ACgBeo1UzyNr5tnVk7KwZeH6L74NkBfXQx9Bl4fGX3zGLjKiuUL5kji4 8O6gtk/h3wFvUvxOsxcFzNQ= X-Google-Smtp-Source: AA6agR43b4+3tGhCCDjMMpmKOfKMX1Ws0nlFdSnKBIpWqyLSQ1nGGe6LCJK9+7IoFU1Ru4vl7VJFbw== X-Received: by 2002:a17:907:6089:b0:72f:56db:ccb6 with SMTP id ht9-20020a170907608900b0072f56dbccb6mr17706602ejc.318.1660072135440; Tue, 09 Aug 2022 12:08:55 -0700 (PDT) Received: from nijino.fritz.box (85-127-52-93.dsl.dynamic.surfer.at. [85.127.52.93]) by smtp.gmail.com with ESMTPSA id m9-20020a1709062b8900b0072af0b036f3sm1422309ejg.41.2022.08.09.12.08.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Aug 2022 12:08:55 -0700 (PDT) Message-ID: Subject: Re: [PATCH] doc: Update contribution guidelines on patches, etc. From: Liliana Marie Prikler To: Maxime Devos , Guix-devel Cc: blake@reproduciblemedia.com, Julien Lepiller , Ludovic =?ISO-8859-1?Q?Court=E8s?= , Philip McGrath Date: Tue, 09 Aug 2022 21:08:53 +0200 In-Reply-To: <97ab139b-3d7c-1919-d51e-79f1c1eb5e33@telenet.be> References: <2fe4881ad87876ae70ef4f3340b34d589a65bb71.camel@gmail.com> <9e87d335-ed11-1bd9-fe72-9ba23ae4af63@telenet.be> <94958dc21ac67cda21530d512ee10b32b76d5d28.camel@gmail.com> <97ab139b-3d7c-1919-d51e-79f1c1eb5e33@telenet.be> Content-Type: text/plain; charset="UTF-8" User-Agent: Evolution 3.42.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2a00:1450:4864:20::642; envelope-from=liliana.prikler@gmail.com; helo=mail-ej1-x642.google.com 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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: "Guix-devel" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1660072359; 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: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=QXbKG9abYQ37Z/KA14jOFXRxTi8Qk221HL+jpBemOss=; b=VOKM72Qm8179eS3rRJjUQRDNA9piumju940fln1vUNo7Gjf4/+uJPvHo/mI2qiKSsAY3Uq bNv2zKhGdTjrMzwEzkf0CuyijF6GcMBuUuZt6wnaqjEg0kaZVnb8SOLsrJf+qMIAOugZp1 5Ph72dPKeQhdPE88Z4Ar1K9ji685xjDvB4ThW5x1R62fx3AeOU4IBqycXnhb4358lI6cgV kWPcX15y+W7V023PwKbWsVKOZrcSfpo4uvLkY2AlWu2EM51xshwwdST6kMnnurpIowXwPW DWwFOUBjAZxypRUGIpMTWtcUyfnQPxklQH8V1x/PIgaqqeKfQPIT+8vBlDpDpg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1660072359; a=rsa-sha256; cv=none; b=HFO9ivcLFHgO0WHq7/BHl4GxjhK4hwavBmHZjxW8tARyNFSpLqyqb08uPInRm8cs01SK+G hfd4IqXPQWSpLHVWwAqdaPCI8kKyyqwaLqxHYxWygcemSBksO9hsB2zruHrKJVkv3JwGgF bu0gm225W/QXMdcK0XSgEjlD400J4UcDqN59u/QP3Ho5ThxRBA5ESVBaO9FbtrVhucNnYv NFmX6s3UwZqxNRCslD6s5l5rj/Yl8ubMYwLWomfIMqHKTLKAt39ZHeU9FqVnBtOrcFGxwO CqBdGV591OiJF1jxhzPc5hp41aRdTai4Jw/OE261vjxEgNpp84Bd2FMxlPoJCA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=qd3d9fSr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -5.69 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=qd3d9fSr; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 6ECC520BC9 X-Spam-Score: -5.69 X-Migadu-Scanner: scn0.migadu.com X-TUID: s4tVN6gK+VR5 Am Dienstag, dem 09.08.2022 um 20:19 +0200 schrieb Maxime Devos: > > Am Dienstag, dem 09.08.2022 um 18:45 +0200 schrieb Maxime Devos: > > > > > On 06-08-2022 08:55, Liliana Marie Prikler wrote: > > > > > > > > > > +If your package has a bug that takes multiple lines to fix, > > > I don't think this is true for replacing all instances of "foo" > > > by > > > "/gnu/store/.../bin/foo" in a file. > > Should it? > I don't think so. Directly substituting all the instances instead of > first writing a patch that does "foo" -> "@foo@" or such seems > simpler to me.  This might be a bit too nit-picky though, maybe it's > clear from context that this is not the kind of fix meant by that > line. I'm struggling to see the issue here. For starters, it doesn't take multiple lines to embed a store path, the change usually happens on a single line. Of course, translating this into a substitute*, you expand this single line into multiple ones, but that's not what is meant here. However, there are exceptions to this rule. For an example that requires indirection, see webkitgtk. > [...] > > > > > > +Such changes include, but are not limited to, fixes of the > > > > build > > > > +script(s) or embeddings of store paths (e.g. [...]) > > > > > > > [...] > > Is that how to English comma? Sorry, I'm not a native speaker so I > > get > > somewhat weirded out by the when to skip/not to skip rules. > > > Neither am I. English doesn't seem to do "rules" much. I do think, > however, that adding a comma after "to" makes things a bit simpler to > read here, and it doesn't appear to be ungrammatical -- at least, in > licenses "but is/are not limited to" is often used that way. Fair enough, will add the comma. > > Derivations are a rather low-level concept, could they be avoided > > in the origin and phases documentation? > > I don't quite see how. You could s/source derivation/the result of > > @code{guix build -S}/, but I don't think that's much better. > > > To be clear, do you mean you: >  * think it's not better, maybe even worse >  * think it's not _much_ better (but still _slightly_ better) >  * are undecided >  * or something else > ? > Also, "guix build -S" returns the source code (after snippet / patch, > if any), not its derivation. For the latter: "guix build -S -d" FWIW I don't think mentioning patch-and-repack is too helpful here either. Also, I'd like to use consistent wording at least within this section, so here "source" means "upstream source" whereas "source derivation" is a shorthand for the stuff Guix builds. Yes, the derivation is not the same thing as the output, but I again fail to see how being overly precise is helpful. That being said, I'm open to suggestions. > > > > +Build phases are limited in that they do not modify the source > > > > +derivation.  Thus, they are inadequate for changes that are to > > > > be > > > > +reflected in the source code.  On the other hand, they only > > > > cause > > > > a > > > > +single rebuild and are thus slightly easier to debug than > > > > phases > > > > and > > > > +snippets. > > > See Andreas' comment on phase->snippet. > > > > > > Also, do I understand correctly that the argument here is that > > > 'single rebuild -> less compilation time -> easier to debug'? > > Easier to debug for the package author currently fiddling with the > > phase/snippet. Not really a statement in any direction otherwise. > I don't see how "slightly easier to debug than phases" follows from > "they cause only a single rebuild". My guess was that the > intermediate step was lower compilation time, but apparently this was > not the argument. As such, I'm not following. I think this follows from your "I only deal with small packages" experience earlier. In my experience, the sources that are more likely to require patches or snippets to fix their... issues... are also the ones that take larger time to patch and repack. After all, you don't have that much overhead unpacking a 7 gig blob that doesn't exist. Cheers