diff options
| author | P. J. McDermott <pehjota> | 2014-09-02 11:35:23 (EDT) |
|---|---|---|
| committer | P. J. McDermott <pj@pehjota.net> | 2014-09-02 11:35:23 (EDT) |
| commit | c34221e63ba0d89f1eedf6821c4799be549fb6d4 (patch) | |
| tree | 2afee888ca7a5d71100acdf6b3007b982900cc8e /doc/pkg | |
| parent | 62719cf6712fd525b213589f91cdd331c5311631 (diff) | |
doc/pkg/basic-expat: Warn about changelog format
Diffstat (limited to 'doc/pkg')
| -rw-r--r-- | doc/pkg/basic-expat.mdwn | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/pkg/basic-expat.mdwn b/doc/pkg/basic-expat.mdwn index e6a587a..e59e747 100644 --- a/doc/pkg/basic-expat.mdwn +++ b/doc/pkg/basic-expat.mdwn @@ -116,6 +116,12 @@ Our expat `changelog` file looks like this: -- "J. Random Hacker" <jrandom@example.com> Sun, 18 Nov 2012 11:58:19 -0500 +Be careful – the changelog format is quite strict and tends to confuse many new +package maintainers. There are no spaces before the package name, version, and +distribution (called the "header"); at least two spaces before each line of +change details; one space before the line starting with `--` (called the +"trailer"); and two spaces between the maintainer and the date. + [spf-changelog]: http://specs.proteanos.com/spf-2.0/metadata.html#changelog |