public inbox for binutils@sourceware.org
 help / color / mirror / Atom feed
From: Simon Marchi <simon.marchi@polymtl.ca>
To: binutils@sourceware.org,
	       "gdb-patches@sourceware.org" <gdb-patches@sourceware.org>
Subject: Using the vcs_to_changelog.py script
Date: Wed, 12 Feb 2020 23:33:00 -0000	[thread overview]
Message-ID: <fae607e5-7fec-b295-a579-7a8ea7c214da@polymtl.ca> (raw)

Hi binutils and gdb folks!

As you may or may not know, the glibc project has started using a script called
vcs_to_changelog.py to automatically generate their ChangeLogs.  They don't do
hand-written ChangeLog entries with their contributions.  Instead they generate
a ChangeLog file using that script when creating a release, passing it a range
of git commits for which to create ChangeLog entries.

I would very much like if we started using this in GDB, and it was suggested
that we could try to sync with binutils, as you might want to do the same.

Here's how it could work in practice:

1. We update our gnulib import to import the vcs_to_changelog.py script (it is
   distributed as a gnulib module).
2. We update src-release.sh to call the script and generate a single top-level
   ChangeLog that is included in the release tarball.

If we use the script as it is today, the ChangeLog generated for a binutils
release will contain entries for commits that don't concern binutils (for
example, that just touch a file under gdb/) and vice-versa.  I don't think
that's really a problem, since all the required information will be there,
there will just be additional information (which I doubt anybody will care
about).  But if really needed, I'm sure the script could be modified to filter
down the commits that touch only what's included in the binutils or GDB
release (I would prefer to avoid doing this unless absolutely necessary).

For illustrative purposes, here's what the script outputs for the last bunch
of commits in binutils-gdb:

  http://paste.ubuntu.com/p/x38zs82Rmt/

That's it, please let me know what you think.

Simon

             reply	other threads:[~2020-02-12 23:33 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-12 23:33 Simon Marchi [this message]
2020-02-13  1:03 ` Alan Modra
2020-02-13  2:29   ` Jeff Law
2020-02-13  3:13     ` Simon Marchi
2020-02-13 14:13     ` Eli Zaretskii
2020-02-13  3:37 ` Eli Zaretskii
2020-02-13 14:19   ` Simon Marchi
2020-02-13 15:42     ` Eli Zaretskii
2020-02-13 16:26       ` Simon Marchi
2020-02-13 18:58         ` Eli Zaretskii
2020-02-13 19:09           ` Philippe Waroquiers
2020-02-13 19:29             ` Eli Zaretskii
2020-02-13 20:56               ` Simon Marchi
2020-02-13 21:07           ` Simon Marchi
2020-02-14  9:45             ` Eli Zaretskii
2020-02-14 19:31               ` Simon Marchi
2020-02-14 20:16                 ` Eli Zaretskii
2020-02-14 21:08                   ` Simon Marchi
2020-02-15  7:26                     ` Eli Zaretskii

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=fae607e5-7fec-b295-a579-7a8ea7c214da@polymtl.ca \
    --to=simon.marchi@polymtl.ca \
    --cc=binutils@sourceware.org \
    --cc=gdb-patches@sourceware.org \
    /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).