From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.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 YGqeBVsz8WF29wAAgWs5BA (envelope-from ) for ; Wed, 26 Jan 2022 12:41:15 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id EJrzOVoz8WHmewAAG6o9tA (envelope-from ) for ; Wed, 26 Jan 2022 12:41:14 +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 93CAD322E3 for ; Wed, 26 Jan 2022 12:41:14 +0100 (CET) Received: from localhost ([::1]:60604 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nCgfp-0006D0-PK for larch@yhetil.org; Wed, 26 Jan 2022 06:41:13 -0500 Received: from eggs.gnu.org ([209.51.188.92]:33252) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nCgff-0006CB-86 for guix-patches@gnu.org; Wed, 26 Jan 2022 06:41:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:58189) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nCgfe-0004HF-Un for guix-patches@gnu.org; Wed, 26 Jan 2022 06:41:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nCgfe-0004Bi-HW for guix-patches@gnu.org; Wed, 26 Jan 2022 06:41:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53163] [PATCH] doc: Document some reasons for/against git tags/commits. Resent-From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 26 Jan 2022 11:41:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 53163 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Maxime Devos Cc: liliana.prikler@gmail.com, 53163@debbugs.gnu.org Received: via spool by 53163-submit@debbugs.gnu.org id=B53163.164319721616035 (code B ref 53163); Wed, 26 Jan 2022 11:41:02 +0000 Received: (at 53163) by debbugs.gnu.org; 26 Jan 2022 11:40:16 +0000 Received: from localhost ([127.0.0.1]:51092 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCget-0004AZ-RN for submit@debbugs.gnu.org; Wed, 26 Jan 2022 06:40:16 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:36224) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nCger-0004AE-Ib for 53163@debbugs.gnu.org; Wed, 26 Jan 2022 06:40:14 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id DD1A045B; Wed, 26 Jan 2022 12:40:06 +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 ZTd3xekqMPeq; Wed, 26 Jan 2022 12:40:06 +0100 (CET) Received: from ribbon (unknown [IPv6:2a01:e0a:1d:7270:af76:b9b:ca24:c465]) by hera.aquilenet.fr (Postfix) with ESMTPSA id C4343316; Wed, 26 Jan 2022 12:40:05 +0100 (CET) From: Ludovic =?UTF-8?Q?Court=C3=A8s?= References: <5623ec2b15bf60a51587b0592ad178b2bec3ef37.camel@telenet.be> Date: Wed, 26 Jan 2022 12:40:05 +0100 In-Reply-To: <5623ec2b15bf60a51587b0592ad178b2bec3ef37.camel@telenet.be> (Maxime Devos's message of "Mon, 10 Jan 2022 15:27:55 +0000") Message-ID: <87czkeiv3e.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: / X-Rspamd-Server: hera X-Rspamd-Queue-Id: DD1A045B 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)[debbugs.gnu.org,gmail.com] 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=1643197274; 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; bh=NNPEXwW+EDf14nh6z2F7LQZZFs6ub32V/wUCO/y2Dos=; b=Uc+CVZU7vxbHnOd8XHkgLImn36HloC2a5D+IGEX2tBj0s5aHd6Y2AQmHuaJhQt0DfpiiRo Hndc7WhhzfvVurL4KqUbHMyAHyA91KaP0puWQK+t5VX8/1mLX6RbU4IxSoVU9IEd9uyq+z pfq9sPZe8vhaNSYPsIkykKiP2Y44jHWhj+cyOc9vU0QfswQjK/cnrZsyQJNJGRv/OSoZ+3 Vqcr9D4NFcuEZhGdQfQpxx9URpGbIzx/U9KB6B8cBv641SZWzBgyHSagiSWzICjX3QRjxF AQvkbHinwIQSTDJYlWIVRmC6dszBDdJD55wDsTU5O5uPk19jk+30RBYYNmB61Q== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1643197274; a=rsa-sha256; cv=none; b=QKmu1090dw0qAPuUzAvf6mTeTjxwyWND4PnNIx8lTZ2NTGNKG61GLBrHPskAyD0C/CQkJV /YSIRe9MrN2UB5BrDBKwy+p9KDJfXEZdIyji2Y0UGEtWDlu9sCKZNI3RGBm6WpoY6FLeNk XOlVm6YK/V9mzIFw4Nh1E7Bejp91jKC4bVmdDNs6GCID28L717vvczvo0XsQBENhwNyii/ 79ywLUfbYWJnrNBvUTLXVBgDK584wPsonQPYBmKRVoRjc/fe7DENbjdf6W6P2XIVpha9+H WtSy1PKtQKAntGmc1AaZ7b5nO/NEvtvEbu6NBc39KNka6hzZ8Mjbe0KPt3wQJA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; 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: -3.63 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; 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: 93CAD322E3 X-Spam-Score: -3.63 X-Migadu-Scanner: scn1.migadu.com X-TUID: JXYhulYHE+Z2 Hi! Maxime Devos skribis: > From 460c25842204936eaf8ead3ab37049e4b93cf086 Mon Sep 17 00:00:00 2001 > From: Maxime Devos > Date: Mon, 10 Jan 2022 15:15:34 +0100 > Subject: [PATCH] doc: Document some reasons for/against git tags/commits. > > * doc/guix.texi (origin Reference): Document some points to consider when > choosing between commits and tags in 'git-reference'. > --- > doc/guix.texi | 19 ++++++++++++++++++- > 1 file changed, 18 insertions(+), 1 deletion(-) > > diff --git a/doc/guix.texi b/doc/guix.texi > index 58ccc75ccf..5c51dc1361 100644 > --- a/doc/guix.texi > +++ b/doc/guix.texi > @@ -7514,7 +7514,24 @@ The URL of the Git repository to clone. > This string denotes either the commit to fetch (a hexadecimal string), > or the tag to fetch. You can also use a ``short'' commit ID or a > @command{git describe} style identifier such as > -@code{v1.0.1-10-g58d7909c97}. > +@code{v1.0.1-10-g58d7909c97}. Often, there is no clear-cut answer to > +the question whether a commit or tag should be used. However, there are > +some points to consider: > + > +If upstream removes old tags or mutates existing tags in-place, then a > +commit should be used to avoid future breakage. Sometimes upstream does > +not tag releases at all, in this case commits are unavoidable. In a > +very few cases (@pxref{Version Numbers}), Guix intentionally uses a > +commit that does not correspond to a release, in which case a commit > +is required. > + > +Some Git repositories only allow checking out tags directly and require > +cloning the entire Git repository to checkout a single commit; using a > +tag would reduce network traffic in these cases. This does not appear to > +be a significant problem in practice, though. > + > +Commits make reviewing somewhat trickier, because the reviewer has to > +verify that that the commit actually corresponds to the package version. I think we should separate reference material from guidelines. Perhaps this should rather go under =E2=80=9CPackaging Guidelines=E2=80=9D, next to= =E2=80=9CVersion Numbers=E2=80=9D? The problem is that it explains the tradeoff but, as you write, does not provide any answer. So it=E2=80=99s not strictly speaking a =E2=80=9Cguide= line=E2=80=9D but may still be useful to have though. Ludo=E2=80=99.