From: Andrew Burgess <andrew.burgess@embecosm.com>
To: John Baldwin <jhb@freebsd.org>
Cc: gdb-patches@sourceware.org
Subject: Re: Stop updating ChangeLog?
Date: Mon, 05 Feb 2018 19:44:00 -0000 [thread overview]
Message-ID: <20180205194405.GD2778@embecosm.com> (raw)
In-Reply-To: <2329026.M5dy4NNrbC@ralph.baldwin.cx>
* John Baldwin <jhb@freebsd.org> [2018-02-05 11:07:16 -0800]:
> On Monday, February 05, 2018 04:00:36 PM Yao Qi wrote:
> > Hi all,
> > The discussion in this thread
> > https://sourceware.org/ml/gdb-patches/2018-02/msg00012.html
> > leads to a discussion that whether we still need ChangeLog. I start
> > a new thread to get more attention on this topic.
> >
> > In current development, we need to write one ore more changelog
> > entries for each commit, put them into both git commit log and
> > ChangeLog files. How much we can change to existing mode
> > depends the answers to these following questions,
> >
> > #1 Are ChangeLog files useful in GDB releases to various people
> > who build GDB releases?
> > #2 Are ChangeLog files useful in GDB repo to various GDB
> > developers?
> >
> > a) If answers are Yes/Yes, we keep unchanged,
> > b) If answers are No/No, we don't need to write changelog entries in
> > git commit log, nor updating ChangeLog file,
> > c) If answer are Yes/No, developers still have to write changelog
> > entries in git commit log, and we can generate ChangeLog on
> > release from git log.
> > d) If answers are No/Yes, get use to git to get the information from
> > git log instead of ChangeLog,
> >
> > My answers are No/No, so I suggest that we do b). I can live up with
> > c), but that needs change in the release process. What do you think?
>
> I probably have a bit of a biased view as most of my development work is done
> without ChangeLogs, so I'm used to just using web interfaces (svnweb, gitweb)
> or vc-annotate in Emacs or the like (git log -S is also super helpful) when
> examining history. I also find the contents of a ChangeLog as I currently
> understand it to be a description of the diff (but not the "why"), so I find
> it to be redundant with 'git diff' rather than providing new information (as
> opposed to the "why" we currently include in commit messages). That probably
> puts me in the No/No camp.
>
> c) would save some work on having to always do 'rebase -i' passes to fixup
> dates in the ChangeLog files before pushing an approved series. (I use
> git-merge-changelog which at last moves the added entries to the top, but I
> still have to go fixup all the dates by hand.)
You might find this useful:
https://github.com/T-J-Teru/dotfiles/blob/master/home/bin/git-update-changelogs
Where previously you would do:
git rebase -i BASE-COMMIT
# Edit each commit to update the date by hand...
You can now just do:
git update-changelogs BASE-COMMIT
And you're done.
Enjoy!
Thanks,
Andrew
next prev parent reply other threads:[~2018-02-05 19:44 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-05 16:00 Yao Qi
2018-02-05 16:30 ` Simon Marchi
2018-02-05 17:23 ` Dmitry Samersoff
2018-02-05 19:04 ` Joseph Myers
2018-02-05 21:56 ` Yao Qi
2018-02-05 22:32 ` Joseph Myers
2018-02-06 7:34 ` Joel Brobecker
2018-02-05 19:08 ` John Baldwin
2018-02-05 19:44 ` Andrew Burgess [this message]
2018-02-06 21:02 ` Maciej W. Rozycki
2018-02-07 9:11 ` Yao Qi
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=20180205194405.GD2778@embecosm.com \
--to=andrew.burgess@embecosm.com \
--cc=gdb-patches@sourceware.org \
--cc=jhb@freebsd.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).