1 |
Hello everyone, |
2 |
|
3 |
as you probably noticed, recently all portage package directories have a |
4 |
new 'ChangeLog' file. This file is supposed to be actively maintained by |
5 |
every ebuild author. If you notice that the file isn't up-to-date, |
6 |
notify the author nicely ;-). The ChangeLog contains information about |
7 |
what has been changed to the package for the user. This makes it easy to |
8 |
determine if the changes are important enough to compile and merge a new |
9 |
version of a package. |
10 |
|
11 |
For ebuild authors: |
12 |
------------------ |
13 |
|
14 |
Remember that this changelog is targetted to users. This means that the |
15 |
comments should be well explained and written in clean English. |
16 |
|
17 |
Every new version or revision of the package has to be marked by a '*' |
18 |
seperator line. Changements since the last revision have to be added to |
19 |
the top of the file, underneath the initial copyright and cvs header |
20 |
comments. |
21 |
|
22 |
This means that you start with header line that has the following |
23 |
format: |
24 |
|
25 |
date; your_name <your_email> changed_file1, changed_file2 : |
26 |
|
27 |
Below that line your explanation should follow. It has to be indented, |
28 |
paragraphed and wrapped at a linewidth of 80 characters. |
29 |
|
30 |
Any details about what exactly changed in the code should be added as a |
31 |
message when the changes are committed to cvs, not to the ChangeLog |
32 |
file. |
33 |
|
34 |
If you have to create a ChangeLog file for a new package, you can take |
35 |
the skel.ChangeLog file to start off with. |
36 |
|
37 |
Best regards, |
38 |
|
39 |
Geert Bevin |
40 |
|
41 |
-- |
42 |
Geert Bevin |
43 |
the Leaf sprl/bvba |
44 |
"Use what you need" Pierre Theunisstraat 1/47 |
45 |
http://www.theleaf.be 1030 Brussels |
46 |
gbevin@×××××××.be Tel & Fax +32 2 241 19 98 |