From c34221e63ba0d89f1eedf6821c4799be549fb6d4 Mon Sep 17 00:00:00 2001
From: P. J. McDermott <pehjota>
Date: Tue, 02 Sep 2014 11:35:23 -0400
Subject: doc/pkg/basic-expat: Warn about changelog format

---
(limited to 'doc/pkg')

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
 
 
--
cgit v0.9.1