From: "Martin Liška" <mliska@suse.cz>
To: Tom Tromey <tom@tromey.com>
Cc: "H.J. Lu" <hjl.tools@gmail.com>, Simon Marchi <simark@simark.ca>,
GDB <gdb@sourceware.org>, Binutils <binutils@sourceware.org>
Subject: Re: Auto update ChangeLog for binutils+gdb commits?
Date: Fri, 29 May 2020 14:25:05 +0200 [thread overview]
Message-ID: <e3e50047-402c-1f9f-6e94-bc67e3242952@suse.cz> (raw)
In-Reply-To: <87tuzzaqey.fsf@tromey.com>
On 5/29/20 2:15 PM, Tom Tromey wrote:
> Martin> I'm the author of the scripts that are currently used in the GCC.
> Martin> As mentioned, we update ChangeLog files by a script that takes all
> Martin> the ChangeLog entries from git commit message. The supported ChangeLog
> Martin> format is documented here:
>
> Martin> https://gcc.gnu.org/codingconventions.html#ChangeLogs
>
> IIUC, we still have to write the ChangeLog entries by hand, just in the
> commit message, and using a much stricter format. Is that accurate?
Yes, the entries should be places to git message.
>
> If so, then this seems less convenient than the status quo. At least
> for me, editing the files is simpler -- I use scripts to handle the
> merges, rebases, and date-updating; and Emacs provides direct support
> for writing the entries in the correct files and it usually gets the
> function name correct as well.
For generation of ChangeLog template, you can use:
https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=contrib/mklog.py;h=243edbb15c522169709902b27a8558c6e0755107;hb=HEAD
It takes a diff a generates a template. Note that PR entries are auto-filled,
new and removed files are automatically added.
About the merges: it's a pain to make a backport (a.k.a) as you're very likely
conflict in ChangeLog entries. Having the ChangeLog entries in message one
can do simple git cherry-pick and it's done.
Note that quite all developers have self made scripts for these situations
and it seems to me an extra work everybody has to do.
>
> It's the convenience of the last part that I'm most concerned about
> losing. If there's a script that does as good a job, then maybe; but
> otherwise it is a -1 from me. My reasoning here is that editing a
> ChangeLog entry is labor-intensive, and anything increasing the labor is
> a negative. It's already a reasonably significant drag on submitting
> patches.
>
> I'd be receptive to removing ChangeLog entirely. I don't believe they
> provide much value. However, I know others disagree on this point, so I
> don't plan to press it.
>
> I'd also be open to changing the format to something requiring zero
> manual intervention. For example, if we could have a commit script that
> simply listed the files and didn't require editing in the names of the
> functions.
Yes, mklog.py does that.
>
> thanks,
> Tom
>
next prev parent reply other threads:[~2020-05-29 12:25 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-26 17:07 Auto generate ChangeLog for binutils commits? H.J. Lu
2020-05-27 14:10 ` Simon Marchi
2020-05-27 14:20 ` H.J. Lu
2020-05-27 14:29 ` Simon Marchi
2020-05-27 15:10 ` Auto update ChangeLog for binutils+gdb commits? H.J. Lu
2020-05-29 7:45 ` Martin Liška
2020-05-29 8:51 ` Martin Liška
2020-05-29 12:15 ` Tom Tromey
2020-05-29 12:25 ` Martin Liška [this message]
2020-05-29 12:44 ` Tom Tromey
2020-05-29 13:56 ` Martin Liška
2020-05-30 10:23 ` Aktemur, Tankut Baris
2020-05-30 11:22 ` Martin Liška
2020-05-30 19:41 ` Tom Tromey
2020-05-31 4:40 ` Fangrui Song
2020-05-31 7:41 ` Jan Vrany
2020-06-01 7:51 ` Martin Liška
2020-05-29 12:28 ` Martin Liška
2020-05-29 13:57 ` Eli Zaretskii
2020-05-30 19:23 ` Tom Tromey
2020-05-30 19:35 ` Eli Zaretskii
2020-06-01 7:39 ` Martin Liška
2020-06-01 14:59 ` Eli Zaretskii
2020-06-02 6:49 ` Martin Liška
2021-01-15 1:18 ` Fangrui Song
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e3e50047-402c-1f9f-6e94-bc67e3242952@suse.cz \
--to=mliska@suse.cz \
--cc=binutils@sourceware.org \
--cc=gdb@sourceware.org \
--cc=hjl.tools@gmail.com \
--cc=simark@simark.ca \
--cc=tom@tromey.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).