Auto generate changelog from git, and use NEWS file properly.

1 files changed, 25 insertions, 24 deletions

diff --git a/ChangeLog b/ChangeLog
index 77dc73a..0bd7f42 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,31 +1,32 @@
-0.8
- - Support FreeBSD 7.2 jails.
+=== ChangeLog discontinued ===
 
-0.7
- - Use new allocated OID from begemot
- - Remove innaccurate jailResidentSize
+ With the move to git, this project is switching from a ChangeLog
+ file to relying on commit messages to provide change history. Please
+ write commit messages in the following format:
 
-0.6
- - Use allocated OID from begemot
+=== begin example commit ===
 
-0.5
- - Add support for monitoring CPU time of a jail.
- - Number of threads in jail exposed via SNMP.
- - Tracking of combined RSS memory of jail.
- - Don't run jail-measure if no jails are running.
+ Short explanation of the commit
 
-0.4
- - Fix problems with capturing IPv6 packets.
+ Longer explanation explaining exactly what's changed, whether any
+ external or private interfaces changed, what bugs were fixed (with bug
+ tracker reference if applicable) and so forth. Be concise but not too
+ brief.
 
-0.3
- - Support multiple IPs per jail.
+=== end example commit ===
 
-0.2
- - Add tracking of number of processes.
- - Don't include jails that have no processes (FreeBSD has these
-   when a socket is hung in an open state).
- - Add tracking of the amount of disk space and files used by
-   the jail.
+ - Always add a brief description of the commit to the _first_ line of
+ the commit and terminate by two newlines. This may be the title of
+ a fixed bug, copied from Bugzilla.
 
-0.1
- - Initial Release
+ - First line (the brief description) must only be one sentence and
+ should start with a capital letter unless it starts with a
+ lowercase symbol or identifier. Don't use a trailing full stop,
+ and don't exceed 72 characters.
+
+ - The main description (the body) is normal prose and should use
+ normal punctuation and capital letters where appropriate.
+
+ - When committing code on behalf of others use the --author option,
+ e.g. git commit -a --author "Joe Coder <joe@coder.org>" and
+ --signoff.