Gentoo Archives: gentoo-dev

From: Mike Frysinger <vapier@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] ChangeLog generation - pros and cons (council discussion request)
Date: Tue, 07 Jun 2011 21:21:01
Message-Id: 201106071720.11259.vapier@gentoo.org
In Reply to: [gentoo-dev] ChangeLog generation - pros and cons (council discussion request) by Fabian Groffen
1 On Thursday, June 02, 2011 05:13:38 Fabian Groffen wrote:
2 > Simple pros I see mentioned:
3
4 additional pro: automatic culling of information no longer relevant. entries
5 dating back to 2002 rarely are useful today. we could easily implement a cap
6 via date, size, files still in the tree, # of entries, etc...
7
8 reality is, if developers want to see what's going on, go to the VCS and get
9 the full history.
10
11 > Simple cons I see mentioned:
12 > - useless information on removals of ebuilds/files
13
14 if people are forcing this crap either way, i dont see it being a con
15
16 > - useless information on whitespace changes
17
18 could easily be mitigated by prefixing the message with '[trivial]' and then
19 the generator skips those
20
21 > - inability to edit ChangeLog entries (typos, bug refs, etc.)
22
23 in practice, i rarely see this being an issue. it certainly hasnt impeded any
24 of the huge projects out there (many of which are bigger than Gentoo) that
25 only have a changelog in the VCS history. typos happen, no one cares, and
26 people get over it.
27
28 > 1) it appears echangelog messages more than just a couple of times
29 > differ from the repoman commit messages; sometimes useful information
30 > is lost when just using the VCS logs
31
32 just bite our lip and move on. as time moves forward, the desync will become
33 relegated to history.
34
35 > 2) typo fixing on VCS-generated logs is sometimes necessary, but
36 > probably impossible
37
38 in practice, it's rarely (if ever) necessary
39
40 > 4) package moves might lose all history for essentially the same files
41
42 this is a technical matter of the generator that can be overcome
43
44 > > -# $Header: /var/cvsroot/gentoo-x86/dev-vcs/git/ChangeLog,v 1.95
45 > > 2011/05/31 06:4 7:22 grobian Exp $
46 > > +# $Header: this/file/is/a/generated/ChangeLog,v 1.1 2011/06/02 09:47:14
47 > > cvsps2changelog Exp $
48 >
49 > The $Header line is likely going to be useless, and probably is best
50 > removed. Is there something useful that can be substituted here?
51
52 the VCS ids used to generate the log (and perhaps their associated dates)
53
54 > sys-devel/gcc-config:
55 > > - 16 Mar 2008; Christian Heim <phreak@g.o> Manifest:
56 > > - Fixing the Manifest (emerge is complaining about missing
57 > > - $FILESDIR/wrapper-1.5.0.o).
58 >
59 > This entry disappears because Manifest and ChangeLog changes are ignored.
60
61 which is fine
62 -mike

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies