From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 90634 invoked by alias); 14 Feb 2020 19:31:21 -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 90549 invoked by uid 89); 14 Feb 2020 19:31:10 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-6.4 required=5.0 tests=AWL,BAYES_00,SPF_HELO_PASS,SPF_PASS autolearn=ham version=3.3.1 spammy=H*i:sk:83blq1p, H*MI:sk:83blq1p, HX-Languages-Length:2410, H*f:sk:83blq1p X-HELO: smtp.polymtl.ca Received: from smtp.polymtl.ca (HELO smtp.polymtl.ca) (132.207.4.11) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 14 Feb 2020 19:31:08 +0000 Received: from simark.ca (simark.ca [158.69.221.121]) (authenticated bits=0) by smtp.polymtl.ca (8.14.7/8.14.7) with ESMTP id 01EJUtns028507 (version=TLSv1/SSLv3 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 14 Feb 2020 14:30:59 -0500 DKIM-Filter: OpenDKIM Filter v2.11.0 smtp.polymtl.ca 01EJUtns028507 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=polymtl.ca; s=default; t=1581708660; bh=2Oi/gQUjW2cojIYG3ia0UCS6c1SWVhmfUdNhnY3t3P0=; h=Subject:To:Cc:References:From:Date:In-Reply-To:From; b=FrR9mEL4juVyhVIF3RwH1/ezGw4e9ZOVNRW55hDN35gUl4mGWm7ntw9wgk6OMbyN2 kneEOKRM0mDrej/YYpNveaOWrcAxoi/8Y/gSv8g2nQO+u4F2y2GJqFxACAS04/Arxw Ih95MZwG/XiF7jMKsJ6o3GIwK3N/z+EWfWdEunzU= Received: from [172.16.0.95] (192-222-181-218.qc.cable.ebox.net [192.222.181.218]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by simark.ca (Postfix) with ESMTPSA id AA69E1E5F3; Fri, 14 Feb 2020 14:30:54 -0500 (EST) Subject: Re: Using the vcs_to_changelog.py script To: Eli Zaretskii Cc: binutils@sourceware.org, gdb-patches@sourceware.org References: <83imkbqhry.fsf@gnu.org> <83a75mqyry.fsf@gnu.org> <675991ee-28c0-ce5a-6327-c6ad80ccb1c3@polymtl.ca> <837e0qqpps.fsf@gnu.org> <83blq1pknp.fsf@gnu.org> From: Simon Marchi Message-ID: Date: Fri, 14 Feb 2020 19:31:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.4.1 MIME-Version: 1.0 In-Reply-To: <83blq1pknp.fsf@gnu.org> Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-SW-Source: 2020-02/txt/msg00368.txt.bz2 On 2020-02-14 4:45 a.m., Eli Zaretskii wrote: >> Cc: binutils@sourceware.org, gdb-patches@sourceware.org >> From: Simon Marchi >> Date: Thu, 13 Feb 2020 16:07:14 -0500 >> >> On 2020-02-13 1:58 p.m., Eli Zaretskii wrote: >>> 2) we need some guidelines for "good commit messages", otherwise >>> patch review will need to pay a lot of attention to discussing >>> that and making sure the log messages are fine >> >> We can write some guidelines for sure, it wouldn't hurt. But I think that as a >> project, we have already some quite good standards in terms of commit messages. > > 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? > > E.g., compare the 2 sample log messages below. The first one will > probably be quite incomplete if the ChangeLog part is removed, while > the second will probably not suffer too much. So we may wish to make > sure log messages like the first one are augmented by additional > information. > > commit 66182876b46d40163e81504f7fa4f206268cb83c > Author: Eli Zaretskii > AuthorDate: Mon Jan 6 21:54:21 2020 +0200 > 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. 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. 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? Simon