Gentoo Archives: gentoo-dev

From: Alec Warner <warnera6@×××××××.edu>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] Changelogs
Date: Wed, 27 Jul 2005 02:08:09
Message-Id: 42E6EBFD.5000003@egr.msu.edu
1 -----BEGIN PGP SIGNED MESSAGE-----
2 Hash: SHA1
3
4
5 Recent discussion on this ML and on the portage-ml as well as
6 #gentoo-portage regarding pkg_warn() and the basic concept behind it.
7 We talked about adding new functionality, about adding a warning section
8 to the ebuild or to the metadata. However. all of these tend to have
9 problems. The dev won't write the extra function, duplication of data
10 in pkg_{post/pre}inst, mangling of metadata.xml.
11
12 Portage current features the -l switch, to show changelogs. It works
13 pretty well to show changes in packages prior to emerging. For example,
14 emerge -uDpvl world -> shows what will emerge then shows the changelogs
15 for each package. For a very large set of packages the output can be
16 overwhelming, however all the changelogs are provided and the user at
17 least has data to parse through.
18
19 The problem is that the ebuild is where all the action is, and the
20 changelogs lay empty. Users cannot run most ebuild functions prior to
21 emerging packages ( usually pkg_postinst() for migrating instructions ),
22 thus any important messages that need to be seen that deal with the
23 package are only seen after it is installed. This is bad because the
24 user is not warned ahead of time about any issues ( new library
25 installed, breaks new processes that link to it ).
26
27 Basically this is a suggestion for developers to put more information in
28 the changelog. You are ( usually ) the maintainer, you know what the
29 program can do, what problems it can cause. Putting this information in
30 pkg_postinst() is good, but putting it in the changelog is better.
31 Believe it or not; users actually read the changelog and hope at times
32 that it provides valuable information about the package and not "marked
33 stable on foo ( #41975 )".
34
35 Marking it stable on an arch and knowing that moving to stable has the
36 potential to break stable systems should be noted in the changelog, even
37 if there is just a pointer to a website, or to the ebuild itself to read
38 the pkg_postinst() and figure out wtf is going to happen.
39
40 *Marches toward better changelogs since most of the current logs are
41 rather skimpy on any details*
42
43 - -Ajec
44 warnera6@×××××××.edu
45 -----BEGIN PGP SIGNATURE-----
46 Version: GnuPG v1.4.1 (GNU/Linux)
47 Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org
48
49 iQIVAwUBQubrsWzglR5RwbyYAQI3dg/+KVFX4GctDzVjfhVDVDzGbx7q+T+0P+yf
50 AYOrsoWuFWcUh2/0FDV8z2aZ1P55M/SBWKgtFmkdMOGTUD34KGTZlyWMlcswxKfO
51 a3D43Dr1DQ6x66I2Gcf3VyHqpBgnPKgVhuNUiuFO8WD5N/W/sICLoTW415GEA7U7
52 jktDqrE+TDKBAdHvY2YaGD8iXZBX0zrS2v/1eeBLJ5/rSVVQfG9DICbMcRZ4lf5L
53 B6ktoarY5xjv6raE9wlZgrkjGpd7VoSn8yRnd10ekwftAlk1JKbAn8TIttWeMmYJ
54 9ZgLm/ZVjxAbzfoRhHjpw1nRb2q5oOeODfZQyOvlWFpZRhvMFySsDddfGsCbC2BS
55 Yf6pf8vKIMHRFLRSSupOl8agzHOm+CSGLHCpv+gs9sZ2eXzO2UjKqnN1VwoMO1sd
56 AJO/z28BvjqnBFU5WsTVmAxhuvziplrLTMfZP93k2VJ3zIni7NhKsLs4rJLnYbbP
57 xFg/Ji/YrZWwqXKFANYV2m/rw2HciKuFQzS2YmrZceAWjPz6s21m4yX6z+Hr1p+3
58 cu1TMIbZsg5ZA5V+nnmV1vfwW1fCLsyItOjYfv9IZi6JdupU22Lr3yR13wcUL6ZN
59 oFt3KmgLzZLjakXiIgICvKT9ZMKBMTkfkHh4qf6cxKmPHPan3Mi+5eBXmPWZ2oGQ
60 Q7gW3j/+Cps=
61 =Ymtl
62 -----END PGP SIGNATURE-----
63 --
64 gentoo-dev@g.o mailing list

Replies

Subject Author
Re: [gentoo-dev] Changelogs Georgi Georgiev <chutz@×××.net>
Re: [gentoo-dev] Changelogs Maurice van der Pot <griffon26@g.o>
Re: [gentoo-dev] Changelogs Jason Stubbs <jstubbs@g.o>