From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.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 GJQtF6iV8mINrQAAbAwnHQ (envelope-from ) for ; Tue, 09 Aug 2022 19:13:12 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id uAX0FqiV8mIetgAA9RJhRA (envelope-from ) for ; Tue, 09 Aug 2022 19:13:12 +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 154F01C6D5 for ; Tue, 9 Aug 2022 19:13:12 +0200 (CEST) Received: from localhost ([::1]:45560 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oLSn1-0007EO-0U for larch@yhetil.org; Tue, 09 Aug 2022 13:13:11 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:46730) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oLSfg-0005Mi-B5 for guix-devel@gnu.org; Tue, 09 Aug 2022 13:05:39 -0400 Received: from mail-ej1-x643.google.com ([2a00:1450:4864:20::643]:41742) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oLSfd-0001vQ-3k; Tue, 09 Aug 2022 13:05:35 -0400 Received: by mail-ej1-x643.google.com with SMTP id gk3so23288319ejb.8; Tue, 09 Aug 2022 10:05:17 -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=DAg/KlEJRe+M+EouNOyeXCsQIyNohuR5rWUfmsWmA5E=; b=ma2K6UT8rKHjBipPIAXToqh/sF6Wix1nkpePxte3/qYzlmBHwDTFXQjSpAyjj1sDH+ XqTNeoIshrcBAYzGFlJAsgg5LnH0bhSfvvpSTa21ZRA1fPj+hLUdS1BSws0YhGeAjsgL fqBYwsHVo0jctZDrS66LHAuTnYPwZk4OKgPuo/uiEBXr0VNgY2zww+W03iLYI59QcBxS pMpSEC9/go3bG5IKbIorVhySMKyUh24E8VhgfGKExUHMvdWFzwZB3KfWkfEO8fcX9h1c Rf0gYwEkGHkpXsEbfTYsZq15UrYfuCY5W/XXpYoK0CiNStW+F30js3xIzc9Aq5QeWFOJ xhCg== 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=DAg/KlEJRe+M+EouNOyeXCsQIyNohuR5rWUfmsWmA5E=; b=fI3Y7cGMeaiKVdiKhaybB1ApGkOXcP9iH0XuxRc5LET6ktqyKCl1uWgksFv2iDaPYe wAjazZJQS9ymiSxLbOX2s0JijzXl63nnLCliMXezZWaAAXQ3to3ghS33YDzpiwrGMAzC EqhJxT8BDos7XTxIHZFWebH//Zo6ODPLZm/rroXWAfZkEUZOoKXbO0iIvdCe6tETubo4 ir8B5elkzvMOZozl62H+fhwdxcoqEGmodDLd91QwKoTEA2Seq66MK6LanwRWeLsDTvT+ 2O3i0AIoQ9HiMta78wRW9pe+3QB513VOV2JnwiwIs8/1lKPc6idFEX7OIM9bymzWsXrY GLXg== X-Gm-Message-State: ACgBeo3uElSF4jbSjBcu1t69CDaisbmv1Xsyy5KtugEf9zvsjQle7UA6 R7Pma8uSzg9hC25e1s5NIjE= X-Google-Smtp-Source: AA6agR4Ex/s512uUc2S71CkqPclwglgzZL1X/4W1gDF4mxPhz6RvS8aAIScnfWvwA3UwW7U07J+lpA== X-Received: by 2002:a17:907:a06b:b0:730:9496:4f63 with SMTP id ia11-20020a170907a06b00b0073094964f63mr17542500ejc.238.1660064716469; Tue, 09 Aug 2022 10:05:16 -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 r16-20020aa7cfd0000000b0043ca6fb7e7dsm6223578edy.68.2022.08.09.10.05.15 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Aug 2022 10:05:16 -0700 (PDT) Message-ID: <94958dc21ac67cda21530d512ee10b32b76d5d28.camel@gmail.com> 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 19:05:15 +0200 In-Reply-To: <9e87d335-ed11-1bd9-fe72-9ba23ae4af63@telenet.be> References: <2fe4881ad87876ae70ef4f3340b34d589a65bb71.camel@gmail.com> <9e87d335-ed11-1bd9-fe72-9ba23ae4af63@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::643; envelope-from=liliana.prikler@gmail.com; helo=mail-ej1-x643.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=1660065192; 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=DAg/KlEJRe+M+EouNOyeXCsQIyNohuR5rWUfmsWmA5E=; b=f/9SrA9iWjHTxbpQ0IRM31awbIx/79SrwA4Ot4aIOSV6WTj2c8E/rODupTtTLHTP0jJtaZ KpG1CPSYbWq7y9AOvm2mkYL0wZPmhEvj+nmJkqnS5Z0+H9vCYlREIoSkPu+lm6rWMUctgD 6Kg+OwdPiS6eeNwDwhDZFCrPIACrwOLlQi9juhHHHJbAjHHOcXrg7fIiBq2Za/i3vtA+Ej lfBhvqCZ3pxsCINS+3x8uWsKBRxsvY9SxR9DLFrD9LQedDRQMZvfDE2MVKhzBBuzGcd1FB coZsxcm6EXuM6olSPnyLEFssa0N4c5oca7B6G3r+SZakHBb5rU09nYzyPwGiKw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1660065192; a=rsa-sha256; cv=none; b=dpLlF2NmD6qqlVr6GTeUZJnFB2p+/o7eEwrj1cAhISt7p8LT+gwcUrO/n5GgOgBfuwyoRs X6bNu/ib/IGObP7b2mqD4KpH5lKyp1ipOR/eCdMzQ3Bf/lCSuPozwokTaamILQxPDVeI3a lSQrQcItFFrQTRaNzRRrBqW64QhzWckXI+TWM9eYTG8h2QEohGCWm9g1ZRBl4KymSRhD+m q7reTL6cmO9E4QmCegtE11r0njmDELZBGNNWi4ihCy8MV+qsab9rupbMp4XIhheu/goqE+ 1MaL6sXpqsvA9sKG4NnrpCxUFLX258IUAi5YkCJY7u7p2abA9ZQvvoopwDIbOw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=ma2K6UT8; 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: -9.49 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=ma2K6UT8; 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: 154F01C6D5 X-Spam-Score: -9.49 X-Migadu-Scanner: scn0.migadu.com X-TUID: sqgUhcwXnXPg 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? > >   or a fix > > +has already been accepted upstream, patches are the preferred way > > of > > +eliminating said bug > > +Refer to the @code{origin} record documentation > > +(particularly the fields @code{snippet} and @code{modules}), for > > more > > +information (@pxref{origin Reference}). > > + > > The "Refer to the ... documentation for more information" occurred in > the old version of (guix)Snippets versus Phases. However, back then, > I did not find more information on how to decide between snippets, > patches and phases, and neither do I now. > > Maybe: > > +Refer to the @code{origin} record documentation > +(@pxref{origin Reference}) (particularly the fields @code{snippet} > and @code{modules}) > +for more information on how to use snippets > > , to avoid a reader's assumption that that section contains > information on deciding between snippets, phases and patches. Yeah, this was meant for "how to use". > > + Furthermore, as with patches, modifying the snippets causes two > > derivations to be built. > > This is true, but I don't think reviewers and package authors have to > worry about that. It does make a difference to the author when debugging their package. Starting with a phase and then moving it to a snippet can save good time. > > Such changes include, but are not limited to fixes of the > > +build script(s) or embeddings of store paths (e.g. replacement of > > +@file{/bin/sh} with @code{(search-input-file inputs "bin/sh")}). > Include what? I think you need to close the subsentence here: > > > +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. > > +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. > 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. > > +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. Cheers