summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2010-01-13 15:56:05 +0000
committerStef Walter <stef@memberwebs.com>2010-01-13 15:56:05 +0000
commite43bf99d505c280c694da7ccd0ab68b5deec187b (patch)
tree737cfcc8de72d9370e520c0d6b4ad260faf932d9
parent8da4a095b4f6bdc8ba3f96c76ab789bc2c330281 (diff)
Auto generate changelog from git, and use NEWS file properly.
-rw-r--r--.gitignore1
-rw-r--r--ChangeLog49
-rw-r--r--Makefile.am13
-rw-r--r--NEWS32
4 files changed, 69 insertions, 26 deletions
diff --git a/.gitignore b/.gitignore
index e2f97f7..8c05992 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,6 +23,7 @@ Makefile.in
/missing
/stamp-h1
/INSTALL
+/compile
/module/jails_oid.h
/module/jails_tree.?
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.
diff --git a/Makefile.am b/Makefile.am
index 1c9dd2e..0e83596 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,5 +2,16 @@ EXTRA_DIST = common
SUBDIRS = module tools doc
dist-hook:
- rm -rf `find $(distdir)/ -name .svn`
+ @if test -d "$(srcdir)/.git"; \
+ then \
+ echo Creating ChangeLog && \
+ ( cd "$(top_srcdir)" && \
+ echo '# Generate automatically. Do not edit.'; echo; \
+ $(top_srcdir)/missing --run git log --stat --date=short ) > ChangeLog.tmp \
+ && mv -f ChangeLog.tmp $(top_distdir)/ChangeLog \
+ || ( rm -f ChangeLog.tmp ; \
+ echo Failed to generate ChangeLog >&2 ); \
+ else \
+ echo 'A git clone is required to generate a ChangeLog' >&2; \
+ fi
diff --git a/NEWS b/NEWS
index c7ab92a..77dc73a 100644
--- a/NEWS
+++ b/NEWS
@@ -1 +1,31 @@
-See ChangeLog \ No newline at end of file
+0.8
+ - Support FreeBSD 7.2 jails.
+
+0.7
+ - Use new allocated OID from begemot
+ - Remove innaccurate jailResidentSize
+
+0.6
+ - Use allocated OID from begemot
+
+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.
+
+0.4
+ - Fix problems with capturing IPv6 packets.
+
+0.3
+ - Support multiple IPs per jail.
+
+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.
+
+0.1
+ - Initial Release