| 1 | # ChangeLog for <CATEGORY>/<PACKAGE_NAME> |
1 | # ChangeLog for <CATEGORY>/<PACKAGE_NAME> |
| 2 | # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 |
2 | # Copyright 1999-2005 Gentoo Foundation; Distributed under the GPL v2 |
| 3 | # $Header: /var/cvsroot/gentoo-x86/skel.ChangeLog,v 1.11 2003/02/17 02:09:27 vapier Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/skel.ChangeLog,v 1.16 2005/01/01 05:46:55 dragonheart Exp $ |
| 4 | |
4 | |
| 5 | *<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (DD MMM YYYY) |
5 | *<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (DD MMM YYYY) |
| 6 | |
6 | |
| 7 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2 : |
7 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2 : |
| 8 | Initial import. Ebuild submitted by submitter_name <submitter_email>. |
8 | Initial import. Ebuild submitted by submitter_name <submitter_email>. |
| … | |
… | |
| 11 | itself. Also note that we now have a single unified paragraph rather than |
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 |
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) |
13 | should be in one block like this. (note by drobbins, 16 Jul 2002) |
| 14 | |
14 | |
| 15 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2: this is |
15 | DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2: this is |
| 16 | an earlier ChangeLog enty. |
16 | an earlier ChangeLog entry. |
| 17 | |
17 | |
| 18 | -- Explanation of ChangeLog format: |
18 | -- Explanation of ChangeLog format: |
| 19 | |
19 | |
|
|
20 | *************************************************************************** |
|
|
21 | THIS IS IMPORTANT: The ChangeLog format is a *chronological* account of all |
|
|
22 | changes made to a set of ebuilds. That means that the most recent ChangeLog |
|
|
23 | entry *always* goes at the top of the file. More explanation below. |
|
|
24 | *************************************************************************** |
|
|
25 | |
|
|
26 | *************************************************************************** |
|
|
27 | ANOTHER IMPORTANT NOTE: There are some ChangeLogs that don't follow this |
|
|
28 | format and organize all changes under the "correct" "*" entry. This is not |
|
|
29 | correct. However, rather than making a concerted effort to fix these |
|
|
30 | ChangeLogs, we should spend our energy defining a comprehensive and strict |
|
|
31 | XML-based ChangeLog format which we then migrate to. But for any entries to |
|
|
32 | any ChangeLog that *you* make, please make sure to always add entries to the |
|
|
33 | top of the file like a good boy/girl. Even do this if it's clear that you're |
|
|
34 | adding an entry to a b0rked ChangeLog. |
|
|
35 | *************************************************************************** |
|
|
36 | |
| 20 | This changelog is targetted to users. This means that the comments should be |
37 | This changelog is targeted to users. This means that the comments should be |
| 21 | well explained and written in clean English. |
38 | well explained and written in clean English. |
| 22 | |
39 | |
| 23 | Every new version or revision of the package should be marked by a '*' |
40 | 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 |
41 | separator line as above to indicate where in the chronology it was first |
| 25 | the top of the file, underneath the initial copyright and cvs header |
42 | added to our CVS tree. Any changes since the last revision, really _any |
| 26 | comments, in exactly the same format as this comment. |
43 | changes at all_ have to be added to the top of the file, underneath the |
|
|
44 | initial copyright and cvs header comments, in exactly the same format as this |
|
|
45 | comment. If you are modifying older ebuilds, simply note them as changed |
|
|
46 | files and add your entry to the top of the ChangeLog. Resist the temptation |
|
|
47 | to "organize" your ChangeLog entries by placing them under the "correct" "*" |
|
|
48 | entries -- this isn't the purpose of the "*" entries. |
| 27 | |
49 | |
| 28 | This means that you start with header line that has the following format, |
50 | This means that you start with header line that has the following format, |
| 29 | indented two spaces: |
51 | indented two spaces: |
| 30 | |
52 | |
| 31 | DD MMM YYYY; your_name <your_email> changed_file1, changed_file2: Your |
53 | DD MMM YYYY; your_name <your_email> changed_file1, changed_file2: Your |