From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id gAbGJsB7fmZIXQEAqHPOHw:P1 (envelope-from ) for ; Fri, 28 Jun 2024 09:00:48 +0000 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id gAbGJsB7fmZIXQEAqHPOHw (envelope-from ) for ; Fri, 28 Jun 2024 11:00:48 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; 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" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1719565248; 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:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=axicbVMQtdsXXL0qYZEuhNTxlIf1Fg79nE0RIlMVkPg=; b=ItfXZrL3/g4mLe0wte5LmtkjdcGpsZsWGmWFq/v6jlieHaYv217ckHhm8rTQgM5Hj7HJXx k5VuaY/GcvTDUSgDqCjR4Va47spdv8uDTrkSur46dGc/+2oUqZcyRlJjgv1AWMK6UCc/G9 hO8k4IoHMJuOYOsNDQA4FR+Gjv8hCgqwyDJ7SjbQYxxblBhwCLJEpbqaZuNxRHzYFDeirz nCZbZ6BcDwxUzM2hLi6awF0cwTAkGASsw1FEVT28Nt6mBKa5b8G6lr0SIpb/RL3Qte/wWz C4blMuVFxXml1evYLS9T6xIMNeRPi0/QIHTgBVsJP4w4KjF2SUiJHvtZf50sVQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1719565248; a=rsa-sha256; cv=none; b=Zlrs7yBTHHR8xYyajkY8H8vEUnZAOmGTRXsaky4l9bN3zchUowKnEmFZX7wU1wegkbBYAV YsrHtQx6fJDHbJFTUVzavqKm/lxBEIEjsJjFOJc43IBz7kv1xxQCAirzeeZw3nW3zR4FMs DO57m3VyAslK+rKVEBibXQWuY0lhLbQ6TVD7mkFJ6DflKmV4YAtGzafF6eO2bssDD+whyI yMvwzy4fRsWJ//BEYkdq5jpfl3cCLDBmX8ShVfvclWiKbQqTVy5rDnovKBVT8GSzwjCFDd IT8vPpbNdsuZkErlkOu0NBKPwkPwVYx36nVT2OtRWiJgQqL3I0I4+Z6PMNl5wA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; 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" 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 4BD02AF79 for ; Fri, 28 Jun 2024 11:00:48 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sN7Sf-0003im-5U; Fri, 28 Jun 2024 05:00:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sN7Sd-0003ib-VD for guix-devel@gnu.org; Fri, 28 Jun 2024 05:00:04 -0400 Received: from hera.aquilenet.fr ([2a0c:e300::1]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sN7Sb-0002It-P3 for guix-devel@gnu.org; Fri, 28 Jun 2024 05:00:03 -0400 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 5373097A; Fri, 28 Jun 2024 11:00:00 +0200 (CEST) X-Virus-Scanned: Debian amavisd-new at hera.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 H5mIYnRncLAQ; Fri, 28 Jun 2024 10:59:59 +0200 (CEST) Received: from jurong (unknown [IPv6:2001:861:c4:f2f0::c64]) by hera.aquilenet.fr (Postfix) with ESMTPSA id 90ED98C9; Fri, 28 Jun 2024 10:59:59 +0200 (CEST) Date: Fri, 28 Jun 2024 10:59:58 +0200 From: Andreas Enge To: Richard Sent Cc: guix-devel@gnu.org Subject: Re: Codifying/Documenting Guix commit message conventions? Message-ID: References: <87bk3mvvfy.fsf@freakingpenguin.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <87bk3mvvfy.fsf@freakingpenguin.com> Received-SPF: pass client-ip=2a0c:e300::1; envelope-from=andreas@enge.fr; helo=hera.aquilenet.fr X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 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-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -1.87 X-Spam-Score: -1.87 X-Migadu-Queue-Id: 4BD02AF79 X-Migadu-Scanner: mx11.migadu.com X-TUID: tpphLdvz0j4r Hello, thanks for bringing up the question! Am Thu, Jun 27, 2024 at 07:04:49PM -0400 schrieb Richard Sent: > Meanwhile in Guix commit messages, [foo] seems to be used to refer to a > subset of a larger part [2]: > From what I'm seeing, the GNU Changelog convention is to indicate > subsets using <> [3]. I also just follow what I see in other commit messages; so probably some of my (and other people's) commit messages are "wrong"... We seem to use <> for a second level of subdivision after []. > 1. Is this in fact a discrepency between the GNU ChangeLog format and > Guix convention or am I missing something? I think it is a difference. > [fixes TROVE-...] blocks added to certain header lines. What other tags > exist? There seems to be inconsistency here when referring to multiple > CVEs. For example, when a fixes tag references multiple CVEs you can > find. > > [fixes CVE-2020-10700, CVE-2020-10704] [5] > [fixes CVE-2020-3898 & CVE-2019-8842] [6] > [fixes CVE-2023-{28755, 28756}] [7] This probably happens rarely enough that no single convention has mendelled out yet. > I'm happy to write up documentation on best practices, but I figure a > general post on guix-devel is a good idea to make sure nothing's missed. >From my point of view, it would be nice if you could try to come up with a set of rules that capture the observed practice, and propose a patch to add them as a section to the manual (somewhere in the chapter that speaks about contributing). Andreas