| 1 |
# ChangeLog for <CATEGORY>/<PACKAGE_NAME>
|
| 2 |
# Copyright 2002 Gentoo Technologies, Inc.; Distributed under the GPL v2
|
| 3 |
# $Header: $
|
| 4 |
|
| 5 |
*<PACKAGE_NAME>-<PACKAGE_VERSION>-<PACKAGE_RELEASE> (DD MMM YYYY)
|
| 6 |
|
| 7 |
DD MMM YYYY; YOUR_NAME <YOUR_EMAIL> changed_file1, changed_file2: Initial
|
| 8 |
import. Ebuild submitted by submitter_name <submitter_email>. Note that the
|
| 9 |
"changed_file" listing is optional if you are simply bumping the rev of the
|
| 10 |
ebuild and are only making changes to the .ebuild file itself. Also note
|
| 11 |
that we now have a single unified paragraph rather than having the first line
|
| 12 |
separated from the rest by a newline. Everything should be in one block like
|
| 13 |
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.
|
| 27 |
|
| 28 |
This means that you start with header line that has the following format,
|
| 29 |
indented two spaces:
|
| 30 |
|
| 31 |
DD MMM YYYY; your_name <your_email> changed_file1, changed_file2: Your
|
| 32 |
explanation should follow. It should be indented and wrapped at a line width
|
| 33 |
of 80 characters. The changed_files can be omitted if they are obvious; for
|
| 34 |
example, if you are only modifying the .ebuild file and committing a new rev
|
| 35 |
of a package. Any details about what exactly changed in the code should be
|
| 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.
|