From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id QLPBNkej3GGEOwAAgWs5BA (envelope-from ) for ; Mon, 10 Jan 2022 22:21:11 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id cD9oM0ej3GEvJgEAauVa8A (envelope-from ) for ; Mon, 10 Jan 2022 22:21:11 +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 47BE23D975 for ; Mon, 10 Jan 2022 22:21:11 +0100 (CET) Received: from localhost ([::1]:42070 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n726G-0005am-Bt for larch@yhetil.org; Mon, 10 Jan 2022 16:21:10 -0500 Received: from eggs.gnu.org ([209.51.188.92]:42526) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n71wq-0004nu-8p for guix-patches@gnu.org; Mon, 10 Jan 2022 16:11:24 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:60499) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n71vW-000566-Fk for guix-patches@gnu.org; Mon, 10 Jan 2022 16:11:22 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n71vW-0001aO-3U for guix-patches@gnu.org; Mon, 10 Jan 2022 16:10:02 -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: guix-patches@gnu.org Resent-Date: Mon, 10 Jan 2022 21:10: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: Liliana Marie Prikler , 53163@debbugs.gnu.org Received: via spool by 53163-submit@debbugs.gnu.org id=B53163.16418489426014 (code B ref 53163); Mon, 10 Jan 2022 21:10:02 +0000 Received: (at 53163) by debbugs.gnu.org; 10 Jan 2022 21:09:02 +0000 Received: from localhost ([127.0.0.1]:53402 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n71uX-0001Yo-Or for submit@debbugs.gnu.org; Mon, 10 Jan 2022 16:09:02 -0500 Received: from andre.telenet-ops.be ([195.130.132.53]:58692) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n71uT-0001YS-Gy for 53163@debbugs.gnu.org; Mon, 10 Jan 2022 16:09:00 -0500 Received: from ptr-bvsjgyhxw7psv60dyze.18120a2.ip6.access.telenet.be ([IPv6:2a02:1811:8c09:9d00:3c5f:2eff:feb0:ba5a]) by andre.telenet-ops.be with bizsmtp id h98q2600F4UW6Th0198vUv; Mon, 10 Jan 2022 22:08:56 +0100 Message-ID: <61f01b2b439db750424023bb2555865ff8139255.camel@telenet.be> From: Maxime Devos Date: Mon, 10 Jan 2022 22:08:45 +0100 In-Reply-To: <3aeda438471930ca3b958a35681a8191cc51fe92.camel@gmail.com> References: <5623ec2b15bf60a51587b0592ad178b2bec3ef37.camel@telenet.be> <3aeda438471930ca3b958a35681a8191cc51fe92.camel@gmail.com> Content-Type: multipart/signed; micalg="pgp-sha512"; protocol="application/pgp-signature"; boundary="=-E9/ZsKMecsQpDaKGoiYg" User-Agent: Evolution 3.38.3-1 MIME-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1641848936; bh=f7Y7qBabum9L37mnwQKw6Z+L5MfggMOz3CGBGAo+POs=; h=Subject:From:To:Date:In-Reply-To:References; b=RSDHCBrseXMQzEiXZi8jouynvcsTaPgHf4UB+QqGsJg/SCzIhtxrXsUKWWQjRk+JZ mOuFFXAQAX4bvOedFXXmq63nD+nbXfwUqCi3v9te4l3EDpiuB17HebMSXngMskpAoy Ehv3e1RiHxijgL/W+jEJfr84JSzKTODFV/decRKcC/muPbrAnpGnx74zoXc2T/Ggeb 9OK6kHERvmSqrXPHeIk2IUt3Qmh4M9ygVfB4VtLiVQlU5fr3Xr5hdmjoi/HNkfVfkw XXUU5lC7GAnETly5SVUKpn2X1uvipwvNunghNPQlz4v9l2//HEup3aai7YVW2eglez 2HjzgcW9ZH3dQ== 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=1641849671; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: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: dkim-signature; bh=f7Y7qBabum9L37mnwQKw6Z+L5MfggMOz3CGBGAo+POs=; b=tGQd55BcYPx1I+Ho1NlATMqYCO4T+qs8gtImR+EJRkTRQ9CSBNqC9uG3DpNXjFiTRPLG+3 13c3SQ3RQDgLN8knIW+bUA0+b5xFW3InpW98RvHDsYcRBUmBkZQp69YuOOkO5eYfLkUb1Z QW5KSyIrhZiDLpNFzNtGPd7W1MSOa5Vd2fskQqElprI5FTlia0t4JNLHt+XMWRCuLMx63s 2kpfXMUjhfhPpTixoopjGvoR/MXgwtocpqF1eskt7hnv8mFbWUd5hlUcqvus9hrr1BMQm8 1H/UTH8ZG287sEIKMsUWpJLO3ih4ItpWkhBEdb7KkYQDuYUsAjB3hHU3KhTJXg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1641849671; a=rsa-sha256; cv=none; b=di8yZQ27gtEEwukOyCnUcx1ZFqVcDGFkdG3HbpQqZJSn1YUni86dtCKId8K693qlJEwAlQ O6IWoKAMSJKLrpppujUz+TdIpz0P66gzOVg2Q9UZfKWA4TAlLthzUd4spxFkUxd4U2FQ0V pZZKsRhp61WLB35ysH42p/d32EHoLu36FL913HRmZ6G1zhwK+CFKvrFt7iZnKaZj3Ywfif oVQxw466wEhYiXJf5NOkY7U0E8NMlZIVeQDfi0pfvfRYT/Jxn4uOuGmBYbT70Qi44+QNeU HwsUYzeU27YeuqdEJESIOJW4y1DdU1zeSRFPLKJJD6GrmwTuRj2X6UxOsewlWw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=telenet.be header.s=r22 header.b=RSDHCBrs; dmarc=fail reason="SPF not aligned (relaxed)" header.from=telenet.be (policy=none); 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: -4.61 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=telenet.be header.s=r22 header.b=RSDHCBrs; dmarc=fail reason="SPF not aligned (relaxed)" header.from=telenet.be (policy=none); 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: 47BE23D975 X-Spam-Score: -4.61 X-Migadu-Scanner: scn0.migadu.com X-TUID: 8a+KU/aQaKL9 --=-E9/ZsKMecsQpDaKGoiYg Content-Type: multipart/mixed; boundary="=-9tWkZ+U6l8zv3bNu75JU" --=-9tWkZ+U6l8zv3bNu75JU Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable A v2 patch with the suggestions applied is attached. Liliana Marie Prikler schreef op ma 10-01-2022 om 20:43 [+0100]: > Hi, >=20 > Am Montag, dem 10.01.2022 um 15:27 +0000 schrieb Maxime Devos: > > 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. > Generally LGTM. >=20 > > +not tag releases at all, in this case commits are unavoidable. In a > > +very few cases (@pxref{Version Numbers}), Guix intentionally uses a > "In a very few cases" looks like a typo. "In few cases" or "In some > exceptional cases" would work well. =E2=80=98In some exceptional cases=E2=80=99 looks better to me, applied. > > +Commits make reviewing somewhat trickier, because the reviewer has > > to > > +verify that that the commit actually corresponds to the package > > version. > I'd also add a line regarding the difficulty to verify that a commit > did once belong to a tag as a future reader, but I'm not sure what > exactly to advise here and how. >=20 Done:=20 =E2=80=98Likewise, commits make it more difficult for a future reader to ve= rify that a commit did once correspond to a version tag=E2=80=99. > In the particular case of minetest, we > have an external map of "tags" to commits that can be queried, but for > most repos I fear the tags would simply be lost to time. Here "tags" =3D releases on content.minetest.net, and not Git tags? > > 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. > That's a general question that has not reached a conclusion yet. IIRC > the goal was to make tags more robust by replacing them with git- > describe like tags. This would also make it easier to port between > revisioned commit and tagged one, since one would have to let-bind > commit either way. FWIW, the git updater in (guix upstream) might need to be modified to support the "git describe" style in commit fields,=C2=A0and a linter to verify that the tag+number corresponds to the commit (to avoid some =E2=80=98tricking peer review=E2=80=99 issues), but otherwise th= is seems rather nice to me. I didn't investigate closely though. Greetings, Maxime. --=-9tWkZ+U6l8zv3bNu75JU Content-Description: Content-Disposition: inline; filename*0=v2-0001-doc-Document-some-reasons-for-against-git-tags-co.pat; filename*1=ch Content-Type: text/x-patch; name="v2-0001-doc-Document-some-reasons-for-against-git-tags-co.patch"; charset="UTF-8" Content-Transfer-Encoding: base64 RnJvbSAyODg3ZmE0MThhNmYwOTdkN2MwNzM4MGFiNmZmNmY5NDUyMDA4MDczIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBNYXhpbWUgRGV2b3MgPG1heGltZWRldm9zQHRlbGVuZXQuYmU+ CkRhdGU6IE1vbiwgMTAgSmFuIDIwMjIgMTU6MTU6MzQgKzAxMDAKU3ViamVjdDogW1BBVENIIHYy XSBkb2M6IERvY3VtZW50IHNvbWUgcmVhc29ucyBmb3IvYWdhaW5zdCBnaXQgdGFncy9jb21taXRz LgoKKiBkb2MvZ3VpeC50ZXhpIChvcmlnaW4gUmVmZXJlbmNlKTogRG9jdW1lbnQgc29tZSBwb2lu dHMgdG8gY29uc2lkZXIgd2hlbgogIGNob29zaW5nIGJldHdlZW4gY29tbWl0cyBhbmQgdGFncyBp biAnZ2l0LXJlZmVyZW5jZScuCi0tLQogZG9jL2d1aXgudGV4aSB8IDIxICsrKysrKysrKysrKysr KysrKysrLQogMSBmaWxlIGNoYW5nZWQsIDIwIGluc2VydGlvbnMoKyksIDEgZGVsZXRpb24oLSkK CmRpZmYgLS1naXQgYS9kb2MvZ3VpeC50ZXhpIGIvZG9jL2d1aXgudGV4aQppbmRleCA1OGNjYzc1 Y2NmLi4yMDE5MmQ5ZTk5IDEwMDY0NAotLS0gYS9kb2MvZ3VpeC50ZXhpCisrKyBiL2RvYy9ndWl4 LnRleGkKQEAgLTc1MTQsNyArNzUxNCwyNiBAQCBUaGUgVVJMIG9mIHRoZSBHaXQgcmVwb3NpdG9y eSB0byBjbG9uZS4KIFRoaXMgc3RyaW5nIGRlbm90ZXMgZWl0aGVyIHRoZSBjb21taXQgdG8gZmV0 Y2ggKGEgaGV4YWRlY2ltYWwgc3RyaW5nKSwKIG9yIHRoZSB0YWcgdG8gZmV0Y2guICBZb3UgY2Fu IGFsc28gdXNlIGEgYGBzaG9ydCcnIGNvbW1pdCBJRCBvciBhCiBAY29tbWFuZHtnaXQgZGVzY3Jp YmV9IHN0eWxlIGlkZW50aWZpZXIgc3VjaCBhcwotQGNvZGV7djEuMC4xLTEwLWc1OGQ3OTA5Yzk3 fS4KK0Bjb2Rle3YxLjAuMS0xMC1nNThkNzkwOWM5N30uICBPZnRlbiwgdGhlcmUgaXMgbm8gY2xl YXItY3V0IGFuc3dlciB0bwordGhlIHF1ZXN0aW9uIHdoZXRoZXIgYSBjb21taXQgb3IgdGFnIHNo b3VsZCBiZSB1c2VkLiAgSG93ZXZlciwgdGhlcmUgYXJlCitzb21lIHBvaW50cyB0byBjb25zaWRl cjoKKworSWYgdXBzdHJlYW0gcmVtb3ZlcyBvbGQgdGFncyBvciBtdXRhdGVzIGV4aXN0aW5nIHRh Z3MgaW4tcGxhY2UsIHRoZW4gYQorY29tbWl0IHNob3VsZCBiZSB1c2VkIHRvIGF2b2lkIGZ1dHVy ZSBicmVha2FnZS4gIFNvbWV0aW1lcyB1cHN0cmVhbSBkb2VzCitub3QgdGFnIHJlbGVhc2VzIGF0 IGFsbCwgaW4gdGhpcyBjYXNlIGNvbW1pdHMgYXJlIHVuYXZvaWRhYmxlLiAgSW4gc29tZQorZXhj ZXB0aW9uYWwgY2FzZXMgKEBweHJlZntWZXJzaW9uIE51bWJlcnN9KSwgR3VpeCBpbnRlbnRpb25h bGx5IHVzZXMgYQorY29tbWl0IHRoYXQgZG9lcyBub3QgY29ycmVzcG9uZCB0byBhIHJlbGVhc2Us IGluIHdoaWNoIGNhc2UgYSBjb21taXQgaXMKK3JlcXVpcmVkLgorCitTb21lIEdpdCByZXBvc2l0 b3JpZXMgb25seSBhbGxvdyBjaGVja2luZyBvdXQgdGFncyBkaXJlY3RseSBhbmQgcmVxdWlyZQor Y2xvbmluZyB0aGUgZW50aXJlIEdpdCByZXBvc2l0b3J5IHRvIGNoZWNrb3V0IGEgc2luZ2xlIGNv bW1pdDsgdXNpbmcgYQordGFnIHdvdWxkIHJlZHVjZSBuZXR3b3JrIHRyYWZmaWMgaW4gdGhlc2Ug Y2FzZXMuIFRoaXMgZG9lcyBub3QgYXBwZWFyIHRvCitiZSBhIHNpZ25pZmljYW50IHByb2JsZW0g aW4gcHJhY3RpY2UsIHRob3VnaC4KKworQ29tbWl0cyBtYWtlIHJldmlld2luZyBzb21ld2hhdCB0 cmlja2llciwgYmVjYXVzZSB0aGUgcmV2aWV3ZXIgaGFzIHRvCit2ZXJpZnkgdGhhdCB0aGF0IHRo ZSBjb21taXQgYWN0dWFsbHkgY29ycmVzcG9uZHMgdG8gdGhlIHBhY2thZ2UgdmVyc2lvbi4KK0xp a2V3aXNlLCBjb21taXRzIG1ha2UgaXQgbW9yZSBkaWZmaWN1bHQgZm9yIGEgZnV0dXJlIHJlYWRl ciB0byB2ZXJpZnkKK3RoYXQgYSBjb21taXQgZGlkIG9uY2UgY29ycmVzcG9uZCB0byBhIHZlcnNp b24gdGFnLgogCiBAaXRlbSBAY29kZXtyZWN1cnNpdmU/fSAoZGVmYXVsdDogQGNvZGV7I2Z9KQog VGhpcyBCb29sZWFuIGluZGljYXRlcyB3aGV0aGVyIHRvIHJlY3Vyc2l2ZWx5IGZldGNoIEdpdCBz dWItbW9kdWxlcy4KLS0gCjIuMzAuMgoK --=-9tWkZ+U6l8zv3bNu75JU-- --=-E9/ZsKMecsQpDaKGoiYg Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- iI0EABYKADUWIQTB8z7iDFKP233XAR9J4+4iGRcl7gUCYdygXRccbWF4aW1lZGV2 b3NAdGVsZW5ldC5iZQAKCRBJ4+4iGRcl7gulAP90+QhZVU30KMC/7mAz+AEFtw8C QcAXWjJsH6tO2MeYhwEAivIdfA6dGPsyNvcQ/6tE7BLuV/2SAMcCfzZy1VudCgU= =mfxQ -----END PGP SIGNATURE----- --=-E9/ZsKMecsQpDaKGoiYg--