diff options
Diffstat (limited to 'skel.ChangeLog')
| -rw-r--r-- | skel.ChangeLog | 78 |
1 files changed, 60 insertions, 18 deletions
diff --git a/skel.ChangeLog b/skel.ChangeLog index 34bc154393ae..8b65f19023db 100644 --- a/skel.ChangeLog +++ b/skel.ChangeLog @@ -1,25 +1,67 @@ # ChangeLog for <CATEGORY>/<PACKAGE_NAME> -# Copyright 2002 Gentoo Technologies, Inc.; Distributed under the GPL +# Copyright 1999-2005 Gentoo Foundation; Distributed under the GPL v2 # $Header: $ -*<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (<DATE>) +*<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (DD MMM YYYY) - 1 Feb 2002; G.Bevin <gbevin@gentoo.org> skel.ChangeLog : - - This changelog is targetted to users. This means that the comments should well - explained and written in clean English. - - Every new version or revision of the package has to be marked by a '*' - seperator line as above. Changements since the last revision have to be - added to the top of the file, underneath the initial comments, in exactly the - same format as this comment. + DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2 : + Initial import. Ebuild submitted by submitter_name <submitter_email>. + Note that the "changed_file" listing is optional if you are simply bumping + the rev of the ebuild and are only making changes to the .ebuild file + itself. Also note that we now have a single unified paragraph rather than + having the first line separated from the rest by a newline. Everything + should be in one block like this. (note by drobbins, 16 Jul 2002) + + DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2: this is + an earlier ChangeLog entry. + +-- 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 means that you start with header line that has the following format : + This changelog is targeted 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 '*' + separator 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. - date; your_name <your_email> changed_file1, changed_file2 : - - Below that line your explanation should follow. It has to be indented, - paragraphed and wrapped at a linewidth of 80 characters. + This means that you start with header line that has the following format, + indented two spaces: - Any details about what exactly changed in the code should be added as a - message when the changes are committed to cvs, not in this file. + DD MMM YYYY; your_name <your_email> changed_file1, changed_file2: Your + explanation should follow. It should be indented and wrapped at a line width + of 80 characters. The changed_files can be omitted if they are obvious; for + example, if you are only modifying the .ebuild file and committing a new rev + of a package. Any details about what exactly changed in the code should be + added as a message when the changes are committed to cvs, not in this file. + +-- A word regarding credit: + + Please add credit information ("ebuild submitted by ...", "patch submitted + by ...") to the ChangeLog. Do not add this information to the ebuilds + themselves. + + And remember: Give credit where credit is due. We're all doing this for + free, so the best we can hope (and expect!) to receive is credit. |