Gentoo Archives: gentoo-dev

From: Ian Stakenvicius <axs@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] Summary line
Date: Tue, 11 Aug 2015 15:27:28
Message-Id: 55CA1457.3030101@gentoo.org
In Reply to: Re: [gentoo-dev] Summary line (was: Re: Referencing bug reports in git) by Kent Fredric
1 -----BEGIN PGP SIGNED MESSAGE-----
2 Hash: SHA256
3
4 On 11/08/15 10:35 AM, Kent Fredric wrote:
5 > On 12 August 2015 at 02:28, Ian Stakenvicius <axs@g.o>
6 > wrote:
7 >> Stuff like 'cat/pn: version bumps', 'cat/pn: new features',
8 >> 'cat/pn: adjusted dependencies' are generic (and short) enough
9 >> yet descriptive enough to see what went on while scanning the
10 >> log.
11 >
12 > I personally find those summaries a bit too terse.
13 >
14 > Mostly, because when I see "A version is bumped" I immediately
15 > expect to know which version the bump is to, but have to dig out
16 > the diff to find out.
17 >
18 > I would also prefer, where possible, to replace "adjusted
19 > dependencies" to be more concise, like "include dev-perl/Foo in
20 > dependencies", ( though of course, apply some taste, listing more
21 > than 3 distinct new dependencies in the summary is execessive,
22 > treat them like hashtags on twitter, 1 is good, 2 is OK, 3 and
23 > you're starting to get crazy )
24 >
25
26 I agree, these are short and don't have nearly as much meaning as
27 they should -- if there's space, absolutely we should add more
28 meaning. I think my point still stands though that the short
29 description should be more like these messages rather than "fix
30 bug#someting" when there's absolutely no indication of what the bug
31 is actually about.
32
33 So long as all of the details are in the main commit message body,
34 of course...
35
36 -----BEGIN PGP SIGNATURE-----
37 Version: GnuPG v2
38
39 iF4EAREIAAYFAlXKFFcACgkQAJxUfCtlWe0FRAEAgrL/FYmdYlA10JQyjkhrWPW6
40 Md6CjK5CCWQh35sz5U8A/Agp6d8HHSu69ZinmhE1VCw9D8TjJ3r5WtQYEo0X8Vhj
41 =WHfg
42 -----END PGP SIGNATURE-----