| 1 | # ChangeLog for <CATEGORY>/<PACKAGE_NAME> |
1 | # ChangeLog for <CATEGORY>/<PACKAGE_NAME> |
| 2 | # Copyright 2002 Gentoo Technologies, Inc.; Distributed under the GPL |
2 | # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 |
| 3 | # $Header: /var/cvsroot/gentoo-x86/skel.ChangeLog,v 1.1 2002/02/01 21:52:59 gbevin Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/skel.ChangeLog,v 1.11 2003/02/17 02:09:27 vapier Exp $ |
| 4 | |
4 | |
| 5 | *<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (<DATE>) |
5 | *<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (DD MMM YYYY) |
| 6 | |
6 | |
| 7 | 1 Feb 2002; G.Bevin <gbevin@gentoo.org> skel.ChangeLog : |
7 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2 : |
|
|
8 | Initial import. Ebuild submitted by submitter_name <submitter_email>. |
|
|
9 | Note that the "changed_file" listing is optional if you are simply bumping |
|
|
10 | the rev of the ebuild and are only making changes to the .ebuild file |
|
|
11 | itself. Also note that we now have a single unified paragraph rather than |
|
|
12 | having the first line separated from the rest by a newline. Everything |
|
|
13 | should be in one block like this. (note by drobbins, 16 Jul 2002) |
|
|
14 | |
|
|
15 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2: this is |
|
|
16 | an earlier ChangeLog enty. |
|
|
17 | |
|
|
18 | -- Explanation of ChangeLog format: |
|
|
19 | |
|
|
20 | This changelog is targetted to users. This means that the comments should be |
|
|
21 | well explained and written in clean English. |
|
|
22 | |
|
|
23 | Every new version or revision of the package should be marked by a '*' |
|
|
24 | seperator line as above. Changes since the last revision have to be added to |
|
|
25 | the top of the file, underneath the initial copyright and cvs header |
|
|
26 | comments, in exactly the same format as this comment. |
| 8 | |
27 | |
| 9 | This changelog is targetted to users. This means that the comments should well |
28 | This means that you start with header line that has the following format, |
| 10 | explained and written in clean English. |
29 | indented two spaces: |
| 11 | |
30 | |
| 12 | Every new version or revision of the package has to be marked by a '*' |
|
|
| 13 | seperator line as above. Changements since the last revision have to be |
|
|
| 14 | added to the top of the file, underneath the initial comments, in exactly the |
|
|
| 15 | same format as this comment. |
|
|
| 16 | |
|
|
| 17 | This means that you start with header line that has the following format : |
|
|
| 18 | |
|
|
| 19 | date; your_name <your_email> changed_file1, changed_file2 : |
31 | DD MMM YYYY; your_name <your_email> changed_file1, changed_file2: Your |
| 20 | |
32 | explanation should follow. It should be indented and wrapped at a line width |
| 21 | Below that line your explanation should follow. It has to be indented, |
33 | of 80 characters. The changed_files can be omitted if they are obvious; for |
| 22 | paragraphed and wrapped at a linewidth of 80 characters. |
34 | example, if you are only modifying the .ebuild file and committing a new rev |
| 23 | |
|
|
| 24 | Any details about what exactly changed in the code should be added as a |
35 | of a package. Any details about what exactly changed in the code should be |
| 25 | message when the changes are committed to cvs, not in this file. |
36 | added as a message when the changes are committed to cvs, not in this file. |
|
|
37 | |
|
|
38 | -- A word regarding credit: |
|
|
39 | |
|
|
40 | Please add credit information ("ebuild submitted by ...", "patch submitted |
|
|
41 | by ...") to the ChangeLog. Do not add this information to the ebuilds |
|
|
42 | themselves. |
|
|
43 | |
|
|
44 | And remember: Give credit where credit is due. We're all doing this for |
|
|
45 | free, so the best we can hope (and expect!) to receive is credit. |