From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: File names in ChangeLog entries Date: Wed, 01 Dec 2021 08:39:06 -0500 Message-ID: References: <831r2xt32t.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28881"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: stefan@marxist.se, emacs-devel@gnu.org To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Dec 01 14:43:11 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1msPt8-0007Ln-Tr for ged-emacs-devel@m.gmane-mx.org; Wed, 01 Dec 2021 14:43:11 +0100 Original-Received: from localhost ([::1]:44714 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1msPt7-0005aB-SS for ged-emacs-devel@m.gmane-mx.org; Wed, 01 Dec 2021 08:43:09 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:46226) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1msPpN-00015L-Ib for emacs-devel@gnu.org; Wed, 01 Dec 2021 08:39:18 -0500 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:4557) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1msPpJ-0005Cb-GE; Wed, 01 Dec 2021 08:39:16 -0500 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 048EA8067C; Wed, 1 Dec 2021 08:39:09 -0500 (EST) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 996C68051E; Wed, 1 Dec 2021 08:39:07 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1638365947; bh=CkR8U+iOagdCL/1nYyGnC31Eqgznt8YGTovTsTmORT8=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=i4FcNMucikd1RcDMG/oyIgy0/tZxpUX3vvz/6LHtx2Dm7XFGg1Jn//igFGGraMRyv XJfHv01N9ymbC0EImSK1HnW/7n6W9XaJBN2d5MWNAeY98njCu+SKeWfKYj2qdV5KMk VMBqpMw7X7rGED8FteB9ydZsd1I+jFFrPa9rBFg4WzEEya9vpJltGpvdO6Ff7/XZU5 hsS7WZxs73UYYO9VqiLRn8gmdeHblj+9rueBOosAup/hJl8zMU6crM7tC6JOJtOWro a3TeUGqMNxbhYOJxKE45HRnIvuAS7L9Dmutk4xxkgYrj9CW+Q6mOCxN9jHvcW6RvXk kFbEYBSZF/E9A== Original-Received: from pastel (unknown [216.154.30.173]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 6BF9C12049B; Wed, 1 Dec 2021 08:39:07 -0500 (EST) In-Reply-To: <831r2xt32t.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 01 Dec 2021 05:29:46 +0200") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:280617 Archived-At: > entries. You (Stefan) are one of the "worst offenders" in that > department: your entries look very frequently backwards: first the > file and function, then an empty line, then the detailed explanation > of the change. It should be the other way around (if you care about > the quality of the logs). Mmmhh... maybe there's a misunderstanding then. I thought the agreed upon format is: * filenames: Short description Explanation. * file1 (func1): desc1. (func2): desc2. * file2 (func3): desc3. Which can degenerate to: * filename (func): Short description Explanation or rest of the description. when the change only touches a single function. And I also use * file1: Short description Explanation. (func1): desc1. (func2): desc2. * file2 (func3): desc3. when the change fundamentally only affects `file1` except for minor adjustments in a few other files. I'm not completely sure about the use of the `* ` at the beginning of the first line, which is not very useful but I keep out of habit. Stefan