diff options
author | 2003-02-25 15:44:02 +0000 | |
---|---|---|
committer | 2003-02-25 15:44:02 +0000 | |
commit | 49a49164e7cf3873d20d3f6fed143b495c95fb08 (patch) | |
tree | 95e33405acc4086b38d038f3808164fc9590c4b7 /skel.ChangeLog | |
parent | Commited stable for hppa. (diff) | |
download | gentoo-2-49a49164e7cf3873d20d3f6fed143b495c95fb08.tar.gz gentoo-2-49a49164e7cf3873d20d3f6fed143b495c95fb08.tar.bz2 gentoo-2-49a49164e7cf3873d20d3f6fed143b495c95fb08.zip |
Updated to clearly reflect our always-existing and never-deprecated *chronological*
ChangeLog policy.
Diffstat (limited to 'skel.ChangeLog')
-rw-r--r-- | skel.ChangeLog | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/skel.ChangeLog b/skel.ChangeLog index 1e2a0191f633..02b0f52ffa3c 100644 --- a/skel.ChangeLog +++ b/skel.ChangeLog @@ -17,13 +17,35 @@ -- Explanation of ChangeLog format: + *************************************************************************** + THIS IS IMPORTANT: The ChangeLog format is a *chronological* account of all + changes made to a set of ebuilds. That means that the most recent ChangeLog + entry *always* goes at the top of the file. More explanation below. + *************************************************************************** + + *************************************************************************** + ANOTHER IMPORTANT NOTE: There are some ChangeLogs that don't follow this + format and organize all changes under the "correct" "*" entry. This is not + correct. However, rather than making a concerted effort to fix these + ChangeLogs, we should spend our energy defining a comprehensive and strict + XML-based ChangeLog format which we then migrate to. But for any entries to + any ChangeLog that *you* make, please make sure to always add entries to the + top of the file like a good boy/girl. Even do this if it's clear that you're + adding an entry to a b0rked ChangeLog. + *************************************************************************** + This changelog is targetted to users. This means that the comments should be well explained and written in clean English. Every new version or revision of the package should be marked by a '*' - seperator line as above. Changes since the last revision have to be added to - the top of the file, underneath the initial copyright and cvs header - comments, in exactly the same format as this comment. + seperator line as above to indicate where in the chronology it was first + added to our CVS tree. Any changes since the last revision, really _any + changes at all_ have to be added to the top of the file, underneath the + initial copyright and cvs header comments, in exactly the same format as this + comment. If you are modifying older ebuilds, simply note them as changed + files and add your entry to the top of the ChangeLog. Resist the temptation + to "organize" your ChangeLog entries by placing them under the "correct" "*" + entries -- this isn't the purpose of the "*" entries. This means that you start with header line that has the following format, indented two spaces: |