Linux Archive

Linux Archive (http://www.linux-archive.org/)
-   Gentoo Development (http://www.linux-archive.org/gentoo-development/)
-   -   RFC: Repoman to autogenerate ChangeLog entries (http://www.linux-archive.org/gentoo-development/429075-rfc-repoman-autogenerate-changelog-entries.html)

Petteri Rty 09-19-2010 01:10 PM

RFC: Repoman to autogenerate ChangeLog entries
 
I assume many of us have wrapper scripts to automatically generate
matching ChangeLog and CVS commit messages. When we eventually move to
git the plan is for the ChangeLog to be automatically generated from
git. To unify developer practices and to ease the transition to git it
has been proposed to make repoman automatically generate ChangeLog
entries. If you have any objections or thought please raise them. One
open question is what should repoman do if there is already a
modification to the ChangeLog file.

Regards,
Petteri

Bugzilla bug:
http://bugs.gentoo.org/show_bug.cgi?id=337853

Krzysztof Pawlik 09-19-2010 01:20 PM

RFC: Repoman to autogenerate ChangeLog entries
 
On 09/19/10 15:10, Petteri Rty wrote:
> I assume many of us have wrapper scripts to automatically generate
> matching ChangeLog and CVS commit messages. When we eventually move to
> git the plan is for the ChangeLog to be automatically generated from
> git. To unify developer practices and to ease the transition to git it
> has been proposed to make repoman automatically generate ChangeLog
> entries. If you have any objections or thought please raise them. One
> open question is what should repoman do if there is already a
> modification to the ChangeLog file.

IMHO: die with an error message similar to:

!!! ChangeLog has been modified, please revert the change or pass
!!! --no-update-changelog to avoid automatic update.

--
Krzysztof Pawlik <nelchael at gentoo.org> key id: 0xF6A80E46
desktop-misc, java, vim, kernel, python, apache...

Dirkjan Ochtman 09-19-2010 01:23 PM

RFC: Repoman to autogenerate ChangeLog entries
 
On Sun, Sep 19, 2010 at 15:20, Krzysztof Pawlik <nelchael@gentoo.org> wrote:
> On 09/19/10 15:10, Petteri Rty wrote:
>> I assume many of us have wrapper scripts to automatically generate
>> matching ChangeLog and CVS commit messages. When we eventually move to
>> git the plan is for the ChangeLog to be automatically generated from
>> git. To unify developer practices and to ease the transition to git it
>> has been proposed to make repoman automatically generate ChangeLog
>> entries. If you have any objections or thought please raise them. One
>> open question is what should repoman do if there is already a
>> modification to the ChangeLog file.
>
> IMHO: die with an error message similar to:
>
> !!! ChangeLog has been modified, please revert the change or pass
> !!! --no-update-changelog to avoid automatic update.

Sounds good to me (both the idea and dying explicitly on modified changelog).

Cheers,

Dirkjan

Fabian Groffen 09-19-2010 02:26 PM

RFC: Repoman to autogenerate ChangeLog entries
 
On 19-09-2010 16:10:15 +0300, Petteri Rty wrote:
> I assume many of us have wrapper scripts to automatically generate
> matching ChangeLog and CVS commit messages. When we eventually move to
> git the plan is for the ChangeLog to be automatically generated from
> git. To unify developer practices and to ease the transition to git it
> has been proposed to make repoman automatically generate ChangeLog
> entries. If you have any objections or thought please raise them. One
> open question is what should repoman do if there is already a
> modification to the ChangeLog file.

I think this idea conflicts with the purpose of the ChangeLog, being
that it should contain relevant information for users only. Technical
details belong to the commit message, as you agreed upon yourself in one
of the commit reviews we had earlier on this list.

That said, I see the benefit of repoman being able to add a ChangeLog
entry, but I think it should refrain if the ChangeLog has been modified.


--
Fabian Groffen
Gentoo on a different level

Mike Auty 09-19-2010 03:17 PM

RFC: Repoman to autogenerate ChangeLog entries
 
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

It should be possible to still maintain this distinction, something like:

"Version bump. Added feature foo.
- --
Feature foo required a complete rewrite of src_install."

And then the ChangeLog generation can happen separately. The problem
with this method is that if we later rely only on commit logs, users may
see things developers hadn't intended them to see. So the question is,
will we always generate changelogs from the version control system, or
will we one day expect the user to directly read the commit logs?

Mike 5:)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.16 (GNU/Linux)

iEYEARECAAYFAkyWKWsACgkQu7rWomwgFXoBoACcCAeaYpUzqu KEyp09NHk7nrrK
w9AAoKf8HtoAY68UMYSEwwvyqemV54M+
=iVC7
-----END PGP SIGNATURE-----

Michał Górny 09-19-2010 04:05 PM

RFC: Repoman to autogenerate ChangeLog entries
 
On Sun, 19 Sep 2010 16:10:15 +0300
Petteri Räty <betelgeuse@gentoo.org> wrote:

> One open question is what should repoman do if there is already a
> modification to the ChangeLog file.

I suggest reverting the ChangeLog modification. That's what my
sunrise-commit [1] does, and it works quite well.

On the other side, shouldn't the git migration remove VCS-side
ChangeLogs completely in favor of regenerating them on the rsync
mirror? I think I'll implement ChangeLog generation feature in
egencache in the near time.

[1] http://github.com/mgorny/sunrise-commit

--
Best regards,
Michał Górny

Peter Volkov 09-20-2010 05:44 AM

RFC: Repoman to autogenerate ChangeLog entries
 
В Вск, 19/09/2010 в 16:17 +0100, Mike Auty пишет:
> It should be possible to still maintain this distinction, something like:
>
> "Version bump. Added feature foo.
> - --
> Feature foo required a complete rewrite of src_install."
>
> And then the ChangeLog generation can happen separately. The problem
> with this method [...]

Another problem that there is no way to alter ChangeLog. Since
ChangeLogs are intended for users it's good idea to be able fix typos /
add credits there and thus it's impossible to generate them from git
commit messages.

--
Peter.


All times are GMT. The time now is 02:50 AM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.