From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by sourceware.org (Postfix) with ESMTP id 21D513861800 for ; Fri, 11 Jun 2021 09:36:09 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 21D513861800 Received: from mail-wr1-f69.google.com (mail-wr1-f69.google.com [209.85.221.69]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-477-CUmLcCcqPWCpFclQzS3TgQ-1; Fri, 11 Jun 2021 05:36:06 -0400 X-MC-Unique: CUmLcCcqPWCpFclQzS3TgQ-1 Received: by mail-wr1-f69.google.com with SMTP id z3-20020adfdf830000b02901198337bc39so2369652wrl.0 for ; Fri, 11 Jun 2021 02:36:06 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=ja1VbK6jOkyAruFzTGKjK3exBKGlBPg5d4gFk8WOx9A=; b=TF/CrAt6suPl586FcxtRnvXnLmaNaK7UfHqY3RKELX12J0ckzQnufYgmuPT+GlJIZW f5Vu4JcPP9pAH+xPkxzUc5r/jAhNE347pmbwySMRqTxhM/m8S+tyCbm0m5wD5ovMSJo7 2UT/9xaFFWtEdU5n6HBPe82O0tG9JeYFGxY66jU1kw8o6WYGV9FcPI7dVXcmFRbJSOxn lvYzPs3eBUCaM8dYM38xcGb7SEZAWQguanFnwpxr31bw2MgOxk1kphvhVLVLVdMXT+1B IUXoKme2gZTe6p9GVs2Xzp2LqWDOgf9pVHXDLjnBQmx0dnwtffWi7lr9JxCBLQ8bz/ne pKbA== X-Gm-Message-State: AOAM5316pNg43MASAwVGxtFADLe0h9X+BR2ctQkNdXU7d+Zr9mSXtH3f XR6t+I7AAYdAdb7hNXmCVDMgjJfeMqyjRu295v8vjKbJnybx4XHn5JVrxn4BUUs80qOUeUGzfDL Ew97SsHQzBOT4caUz9EUeGPg= X-Received: by 2002:adf:906a:: with SMTP id h97mr3011710wrh.311.1623404165354; Fri, 11 Jun 2021 02:36:05 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwmmQYT38CIEtHAlNac6CdH4DqEVCP//ZBFWV+FAcslhvc99uRPB6+yfaZPcv+gkwYaQntD9i2UvnYeI42c9x4= X-Received: by 2002:adf:906a:: with SMTP id h97mr3011689wrh.311.1623404165151; Fri, 11 Jun 2021 02:36:05 -0700 (PDT) MIME-Version: 1.0 References: <36a4f5c4-357a-ca1c-e7f5-ede6ff3ba445@suse.cz> <20210610100851.GD7746@tucnak> <1230cb99-ed83-3e4e-8362-94f03ee021bc@gmail.com> <3228435b-aba0-6157-3266-c0f025822829@gmail.com> In-Reply-To: From: Jonathan Wakely Date: Fri, 11 Jun 2021 10:35:54 +0100 Message-ID: Subject: Re: git gcc-commit-mklog doesn't extract PR number to ChangeLog To: Martin Sebor Cc: Jakub Jelinek , gcc@gcc.gnu.org X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="UTF-8" X-Spam-Status: No, score=-6.3 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: gcc@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 11 Jun 2021 09:36:10 -0000 On Fri, 11 Jun 2021 at 10:08, Jonathan Wakely wrote: > > On Thu, 10 Jun 2021 at 18:06, Martin Sebor wrote: > > By "the subject line" are you referring to what the ChangeLog calls > > $git_description, and, AFAICS, consists of multiple lines? (Based > > on the Example patch on the conventions page. In that example, > > the PR87763 reference is in the middle of line 3.) > > > No, I mean the first line of the $git_description, which would also be Sorry, the end of that sentence got lost on my clipboard. The first line of the $git_description would also be the Subject of your email, if you follow established Git best practices (e.g. in the kernel, GitHub and elsewhere). For further reading: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_commit_template https://chris.beams.io/posts/git-commit/ https://reflectoring.io/meaningful-commit-messages/#formatting This one suggests a lot more structure, which is partially in conflict with GCC's own guidelines, but it agrees that the commit msg should start with a single-line description: https://www.conventionalcommits.org/en/v1.0.0/ If you're not already doing a brief "subject" line in your git commits, you're Doing It Wrong! This is why I want the docs to go into more detail on the content of the $git_description part of the git commit msg, because then reusing that subject as your email Subject: is a no-brainer. So if you're confused whether I mean the (first line of the) $git_description or the email Subject: you should ask yourself why you think there is any distinction between the two :-) And for the avoidance of doubt ... > > Again, I'm not sure what exactly you mean by "the changelog" here. > > Are you referring to the whole commit message or just to what > > the conventions refer to as the ChangeLog entry? > > The latter. When I say changelog, I mean the changelog, and when I say commit message, I mean the whole git commit message. I don't say "changelog" to mean the whole git commit message. I'm using the terminology of the codingconventions.html page: "ChangeLog entries are part of git commit messages and are automatically put into a corresponding ChangeLog file." Using "changelog" to mean the whole commit message would be confusing and/or ambiguous.