From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 50597 invoked by alias); 8 Nov 2019 13:43:22 -0000 Mailing-List: contact gcc-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Archive: List-Post: List-Help: Sender: gcc-owner@gcc.gnu.org Received: (qmail 50589 invoked by uid 89); 8 Nov 2019 13:43:22 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-6.6 required=5.0 tests=AWL,BAYES_00,SPF_PASS autolearn=ham version=3.3.1 spammy= X-HELO: foss.arm.com Received: from foss.arm.com (HELO foss.arm.com) (217.140.110.172) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 08 Nov 2019 13:43:20 +0000 Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 46F5E46A; Fri, 8 Nov 2019 05:43:18 -0800 (PST) Received: from e120077-lin.cambridge.arm.com (e120077-lin.cambridge.arm.com [10.2.206.225]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id AA8663F719; Fri, 8 Nov 2019 05:43:17 -0800 (PST) Subject: Re: Commit messages and the move to git To: esr@thyrsus.com, Jeff Law Cc: GCC Development References: <20191107142727.GA72444@thyrsus.com> From: "Richard Earnshaw (lists)" Message-ID: Date: Fri, 08 Nov 2019 13:43:00 -0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: <20191107142727.GA72444@thyrsus.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit X-SW-Source: 2019-11/txt/msg00073.txt.bz2 On 07/11/2019 14:27, Eric S. Raymond wrote: > Jeff Law : >> On 11/4/19 3:29 AM, Richard Earnshaw (lists) wrote: >>> With the move to git fairly imminent now it would be nice if we could >>> agree on a more git-friendly style of commit messages; and, ideally, >>> start using them now so that the converted repository can benefit from >>> this. >>> >>> Some tools, particularly gitk or git log --oneline, can use one-line >>> summaries from a commit's log message when listing commits.  It would be >>> nice if we could start adopting a style that is compatible with this, so >>> that in future commits are summarized in a useful way.  Unfortunately, >>> some of our existing commits show no useful information with tools like >>> this. >> I'd suggest we sync policy with glibc. They're further along on the >> ChangeLog issues. Whatever they do in this space we should follow -- >> aren't we going to be using some of their hooks/scripts? > > Note that my reposurgeon conversion recipe runs gitify on the repository. > > From the documentation: > > Attempt to massage comments into a git-friendly form with a blank > separator line after a summary line. This code assumes it can insert > a blank line if the first line of the comment ends with '.', ',', ':', > ';', '?', or '!'. If the separator line is already present, the comment > won't be touched. > > Takes a selection set, defaulting to all commits and tags. > Which makes me wonder if, given a commit log of the form: 2019-10-30 Richard Biener PR tree-optimization/92275 * tree-vect-loop-manip.c (slpeel_update_phi_nodes_for_loops): Copy all loop-closed PHIs. * gcc.dg/torture/pr92275.c: New testcase. Where the first line is a ChangeLog style date and author, we could spot the PR line below that and hoist it up as a more useful summary (perhaps by copying it rather than moving it). It wouldn't fix all commits, but even just doing this for those that have PRs would be a help. R.