From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 51756 invoked by alias); 14 Feb 2020 20:16:10 -0000 Mailing-List: contact binutils-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: binutils-owner@sourceware.org Received: (qmail 51549 invoked by uid 89); 14 Feb 2020 20:15:50 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-3.9 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_LOW,SPF_PASS autolearn=ham version=3.3.1 spammy=H*f:sk:fa27c27, HX-Languages-Length:2138, H*MI:sk:fa27c27 X-HELO: eggs.gnu.org Received: from eggs.gnu.org (HELO eggs.gnu.org) (209.51.188.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 14 Feb 2020 20:15:42 +0000 Received: from fencepost.gnu.org ([2001:470:142:3::e]:39285) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1j2hNE-0007PI-M9; Fri, 14 Feb 2020 15:15:40 -0500 Received: from [176.228.60.248] (port=4585 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1j2hNE-0007zm-03; Fri, 14 Feb 2020 15:15:40 -0500 Date: Fri, 14 Feb 2020 20:16:00 -0000 Message-Id: <83pnehncwe.fsf@gnu.org> From: Eli Zaretskii To: Simon Marchi CC: binutils@sourceware.org, gdb-patches@sourceware.org In-reply-to: (message from Simon Marchi on Fri, 14 Feb 2020 14:30:54 -0500) Subject: Re: Using the vcs_to_changelog.py script References: <83imkbqhry.fsf@gnu.org> <83a75mqyry.fsf@gnu.org> <675991ee-28c0-ce5a-6327-c6ad80ccb1c3@polymtl.ca> <837e0qqpps.fsf@gnu.org> <83blq1pknp.fsf@gnu.org> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-SW-Source: 2020-02/txt/msg00370.txt.bz2 > Cc: binutils@sourceware.org, gdb-patches@sourceware.org > From: Simon Marchi > Date: Fri, 14 Feb 2020 14:30:54 -0500 > > > AFAIU, our current standards assume the ChangeLog-formatted entry is > > part of the log message which describes the individual changes. If > > that is removed, we may wish to modify our standards to make up for > > the loss. > > Do you know where that is written? I don't know. I just describe the current state of things. > > Commit: Eli Zaretskii > > CommitDate: Mon Jan 6 21:54:21 2020 +0200 > > > > Fix MinGW native compilation of gdb/gdbsupport/gdb_wait.c > > > > gdb/ChangeLog > > 2020-01-06 Eli Zaretskii > > > > * gdbsupport/gdb_wait.c: Include instead of > > gdb/signals.h, as we are now using native signal symbols. > > Well, you would essentially just say the same thing, just not in "ChangeLog > entry" format. I'm not sure what's the problem here. I'm saying that we should tell somewhere what should be in the log message regarding the actual changes. > Note that if I were to review this patch, I would probably ask for a bit more > context in the commit log though (on top of what you already say in the > ChangeLog entry). I'm sure there was a big discussion that lead to this change, > so from your point of view, this change probably seemed obvious. But as > somebody lacking the relevant context, I can't really tell why including > gdb/signals.h was wrong and why including signal.h is better. First, I can in principle push changes without waiting for review. And there are quite a few cases where I post patches without ChangeLog entries (which I add later, when actually pushing). In both cases, you'd not see the log message I'm about to push. So I think it would be good to have some guidelines about that. > I would therefore suggest adding: > > - What's the problem you're trying to fix (compilation error? if so please > paste it in the commit log?) > - Why is this the right way to fix it? Something like that, yes. I'm saying that we should have this on the wiki.