From patchwork Mon Jan 10 15:27:55 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: M X-Patchwork-Id: 36205 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id E809C27BBEA; Mon, 10 Jan 2022 16:22:02 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 61D6A27BBE9 for ; Mon, 10 Jan 2022 16:22:02 +0000 (GMT) Received: from localhost ([::1]:38972 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n6xQn-00046s-J5 for patchwork@mira.cbaines.net; Mon, 10 Jan 2022 11:22:01 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54048) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n6xM1-0006oI-BB for guix-patches@gnu.org; Mon, 10 Jan 2022 11:17:05 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:60237) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n6xLz-0007Xg-B5 for guix-patches@gnu.org; Mon, 10 Jan 2022 11:17:05 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n6xLz-0002En-7W; Mon, 10 Jan 2022 11:17:03 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53163] [PATCH] doc: Document some reasons for/against git tags/commits. Resent-From: Maxime Devos Original-Sender: "Debbugs-submit" Resent-CC: liliana.prikler@gmail.com, guix-patches@gnu.org Resent-Date: Mon, 10 Jan 2022 16:17:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 53163 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53163@debbugs.gnu.org Cc: liliana.prikler@gmail.com X-Debbugs-Original-To: guix-patches@gnu.org X-Debbugs-Original-Xcc: liliana.prikler@gmail.com Received: via spool by submit@debbugs.gnu.org id=B.16418313698510 (code B ref -1); Mon, 10 Jan 2022 16:17:03 +0000 Received: (at submit) by debbugs.gnu.org; 10 Jan 2022 16:16:09 +0000 Received: from localhost ([127.0.0.1]:53137 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n6xL6-0002D6-R1 for submit@debbugs.gnu.org; Mon, 10 Jan 2022 11:16:09 -0500 Received: from lists.gnu.org ([209.51.188.17]:57468) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n6xL2-0002Ck-C4 for submit@debbugs.gnu.org; Mon, 10 Jan 2022 11:16:07 -0500 Received: from eggs.gnu.org ([209.51.188.92]:53814) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n6xKw-0003xN-Qw for guix-patches@gnu.org; Mon, 10 Jan 2022 11:16:04 -0500 Received: from [2a02:1800:110:4::f00:18] (port=34462 helo=michel.telenet-ops.be) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n6xKp-0007Kj-Bt for guix-patches@gnu.org; Mon, 10 Jan 2022 11:15:58 -0500 Received: from ptr-bvsjgyhxw7psv60dyze.18120a2.ip6.access.telenet.be ([IPv6:2a02:1811:8c09:9d00:3c5f:2eff:feb0:ba5a]) by michel.telenet-ops.be with bizsmtp id h4Fn2600g4UW6Th064FnY1; Mon, 10 Jan 2022 17:15:48 +0100 Message-ID: <5623ec2b15bf60a51587b0592ad178b2bec3ef37.camel@telenet.be> From: Maxime Devos Date: Mon, 10 Jan 2022 15:27:55 +0000 MIME-Version: 1.0 User-Agent: Evolution 3.38.3-1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1641831348; bh=cEcujedfZWCc/q5jRYDbxngcbppy7YmbGil/9aKv33A=; h=Subject:From:To:Date; b=dVUyTpdCJ0XG439UgWcuVKKniBLdFhuoYfYBBR0dHJSgFRae9oe1w4otufbBOOsU/ B12wVQPDvjfCM1rNiEOS3kLWTpkHUKZ5G5NkBdCctVe+3If0tqcv9A/CUtnU739U1U ATmHSqFL51Pg6ST+IRuYHUNzaKHlYAV5U5lyHjLjZyaDAUWqZLWPlHy3eR1RwaV9Wm 2r3FCEwRNcG8Sd8Ywb/6Kww/O2rPhzxxNWCNMms/FwM+VffIt9MLD/hfbOuEF4Y3gC xrXsIf26jTa3MYY9kq1K2FkpNX8MsxWD5mON7d+4/mHf04M4Z2+rTUM6HEEUqSEH8b OH6QVL+nOwNCg== X-Host-Lookup-Failed: Reverse DNS lookup failed for 2a02:1800:110:4::f00:18 (failed) Received-SPF: pass client-ip=2a02:1800:110:4::f00:18; envelope-from=maximedevos@telenet.be; helo=michel.telenet-ops.be X-Spam_score_int: -9 X-Spam_score: -1.0 X-Spam_bar: - X-Spam_report: (-1.0 / 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, FREEMAIL_REPLY=1, RCVD_IN_DNSWL_LOW=-0.7, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action 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+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches X-Debbugs-CC: liliana.prikler@gmail.com Hi, For , I'd like to be able to reference some section (not specialised for Minetest packages, instead more general) explaining when and when not to use git tags/commits. I'm not familiar with "git describe", so the documentation doesn't tell when to use "git describe"-style tag-number of commits-commit strings. Greetings, Maxime. 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. @item @code{recursive?} (default: @code{#f}) This Boolean indicates whether to recursively fetch Git sub-modules. base-commit: 9fd4f4b09cc0495d6b1418f171ff738a1086cc00 prerequisite-patch-id: 9e070819096a5b3df220706866de3f9a24700add prerequisite-patch-id: 9e081caf6df1e9b7fa4ecf0e816089cb65897d7b prerequisite-patch-id: 8fa14cb2d1fcc4b4d5be227bf8a2691a912500c0 prerequisite-patch-id: 3d4bf2cbd36e29a031c6ccd13fdf4edd51b67652 prerequisite-patch-id: b740911b2fab6e87f003e13ce21d3c726d7ffeb6 prerequisite-patch-id: 2495e12d0efbf42fe847e7411a9c7abbf6b09c38 prerequisite-patch-id: f281231d96059179b6b891d999dda798b099e2fb prerequisite-patch-id: c60b330f96721da1f7790dd29b5d428e312e7b2e prerequisite-patch-id: a3ab55eaf0dece586c513fa5671414ff902eb1cd prerequisite-patch-id: ff47ed0086837f18293d67e5edd01ca14c6f84c9 prerequisite-patch-id: 2c805f40c37fed3eb8e69456d4c90c0a75b643be prerequisite-patch-id: dfc9534307fd4365205bcd22cea57c3e196b29e8 prerequisite-patch-id: 5035d75f6463dbcc8d7e29782ba9b1f7a5867c42 -- 2.30.2