From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 3EC61158089 for ; Sun, 29 Oct 2023 20:23:00 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 845522BC016; Sun, 29 Oct 2023 20:22:59 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 667312BC016 for ; Sun, 29 Oct 2023 20:22:59 +0000 (UTC) Received: from oystercatcher.gentoo.org (oystercatcher.gentoo.org [148.251.78.52]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 7FE5F335C0F for ; Sun, 29 Oct 2023 20:22:58 +0000 (UTC) Received: from localhost.localdomain (localhost [IPv6:::1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id DFC7E1289 for ; Sun, 29 Oct 2023 20:22:56 +0000 (UTC) From: "Sam James" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Sam James" Message-ID: <1698610971.dbc3fda4b0ca7be794e0aeea1ca3c775313cf86f.sam@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: general-concepts/mirrors/, general-concepts/manifest/ X-VCS-Repository: proj/devmanual X-VCS-Files: general-concepts/manifest/text.xml general-concepts/mirrors/text.xml X-VCS-Directories: general-concepts/manifest/ general-concepts/mirrors/ X-VCS-Committer: sam X-VCS-Committer-Name: Sam James X-VCS-Revision: dbc3fda4b0ca7be794e0aeea1ca3c775313cf86f X-VCS-Branch: master Date: Sun, 29 Oct 2023 20:22:56 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply X-Archives-Salt: 10c414cd-a516-4add-99e7-10d8b07d9ff1 X-Archives-Hash: a94691fdd536888d4a09f125388b7f5f commit: dbc3fda4b0ca7be794e0aeea1ca3c775313cf86f Author: Sam James gentoo org> AuthorDate: Thu Oct 26 23:35:47 2023 +0000 Commit: Sam James gentoo org> CommitDate: Sun Oct 29 20:22:51 2023 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=dbc3fda4 general-concepts: discuss concerns with regenerating existing distfile entries In a discussion with Eli Schwartz, I realised the devmanual doesn't currently explicitly state best practice. In general-concepts/mirrors, link to the new Manifest regeneration section and shift some text around into that new section too (and adjust the text slightly while at it). Signed-off-by: Sam James gentoo.org> Closes: https://github.com/gentoo/devmanual/pull/318 Signed-off-by: Sam James gentoo.org> general-concepts/manifest/text.xml | 36 ++++++++++++++++++++++++++++++++++++ general-concepts/mirrors/text.xml | 9 ++------- 2 files changed, 38 insertions(+), 7 deletions(-) diff --git a/general-concepts/manifest/text.xml b/general-concepts/manifest/text.xml index 19ea5c3..bee1651 100644 --- a/general-concepts/manifest/text.xml +++ b/general-concepts/manifest/text.xml @@ -39,6 +39,42 @@ action from developers.

+ + +Updating <c>Manifest</c> files + + +

+Updating existing entries within a manifest must be done with care. Upstream +changing the tarball in-place without a new filename could be an innocent +respin of the tarball, or it could indicate either the previous or the new +tarball is malicious. +

+ +

+Developers should diff the old and new versions of the distfile, comparing +the two, and note the differences in the commit message updating the +Manifest to indicate both what happened (if any context is known) and +also what differences between the two distfiles have been ascertained. +

+ +

+Please note that if upstream made any changes affecting the built +package or it had substantial differences, you need to also bump the ebuild's +revision. Finally, remember to remove the ebuilds that are associated with the +old distfile, or regenerate their checksums in Manifest, if there +are any. This is necessary because these ebuilds will cause checksum +mismatch errors as the checksum recorded in the manifest file no +longer matches the computed checksum of the fetched distfile. +

+ +

+Special care is also required with regard to + +mirrors. +

+ + diff --git a/general-concepts/mirrors/text.xml b/general-concepts/mirrors/text.xml index 6b4993e..f1ce1bb 100644 --- a/general-concepts/mirrors/text.xml +++ b/general-concepts/mirrors/text.xml @@ -68,13 +68,8 @@ fetch and start distributing the new version.

-Please note that if upstream made any changes affecting the built -package, you need to also bump the ebuild's revision. Finally, -remember to remove the ebuilds that are associated with the old -distfile, or regenerate their checksums in Manifest, if there -are any. This is necessary because these ebuilds will cause checksum -mismatch errors as the checksum recorded in the Manifest file no -longer matches the computed checksum of the fetched distfile. +Updating an existing distfile is generally cause for concern and must be done +with care, see .