diff options
| author | P. J. McDermott <pjm@nac.net> | 2012-02-24 18:48:20 (EST) |
|---|---|---|
| committer | P. J. McDermott <pjm@nac.net> | 2012-02-24 18:48:20 (EST) |
| commit | ea0d945b800e10ab5f0642ff84e86a8aeee4b705 (patch) | |
| tree | 986d8cfcab05fe5ec3f023530056a8de4e56bde8 | |
| parent | 3b274bd7e463dc6a080c155c85e73fbfd450d67e (diff) | |
Document source package change log format.
| -rw-r--r-- | specs/source-package-format-1.0.txt | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/specs/source-package-format-1.0.txt b/specs/source-package-format-1.0.txt index 2e1fa04..3fa28dd 100644 --- a/specs/source-package-format-1.0.txt +++ b/specs/source-package-format-1.0.txt @@ -153,3 +153,34 @@ The fields in the source package metadata are: origin source code and documentation and/or information. Though the information in this field is machine-usable, the URL must not be surrounded by angle brackets or any other characters. + + +Change Log Format +================= + +Changes made to the source package should be explained in the file 'changelog'. + +Each new package revision must be documented with an entry of the following format: + package (version) + [zero or more blank lines] + * change details + [zero or more blank lines] + * more change details + more detailed change details + [zero or more blank lines] + -- maintainer date + +"package" is the source package name. + +"version" is the source package version number. + +"maintainer" is the name and e-mail address of the package maintainer. This +field must follow the syntax of the "mailbox" symbol of RFC 5322 section 3.4. + +"date" is the date of packaging. This field must follow the syntax of the +"date-time" symbol of RFC 5322 section 3.3. + +It is recommended that single blank lines be used: + * After the package name and version and before change entries, + * After change entries and before the maintainer and date, and + * Between groups of related change entries. |