summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2009-10-29 01:41:02 +0000
committerStef Walter <stef@memberwebs.com>2009-10-29 01:41:02 +0000
commitbc97679627a6b73a8c951bca754c9445774f598b (patch)
treea0ac5c8264489b3a9befceafab67da1b9b6d3265
parent608954afbd2dd93b1ae9d7cc59a77e1ae03dfd03 (diff)
Work better with git and other tools.
-rw-r--r--ChangeLog43
-rw-r--r--Makefile.am14
-rw-r--r--NEWS20
-rwxr-xr-xautogen.sh14
4 files changed, 71 insertions, 20 deletions
diff --git a/ChangeLog b/ChangeLog
index d65639d..0bd7f42 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,19 +1,32 @@
-0.5:
- * Fix line off by one error.
+=== ChangeLog discontinued ===
-0.4:
- * Add regexCounter variable for 64 bit values
- * Fix assertion when selecting text at end of line
- * Fix problems when large buffers come in at once with multiple lines.
+ 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.3:
- * Use my real name 'Stefan Walter':
- See: http://memberwebs.com/nielsen/
+=== begin example commit ===
-0.2:
- * Fix bug with an assert on long lines
- * Better configure.in checks.
- * Cleanup the MIB a bit
+ Short explanation of the commit
-0.1:
- * Initial Release.
+ 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.
+
+=== end example commit ===
+
+ - 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.
+
+ - 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 8cbbd5d..8286fbb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,16 @@
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..d65639d 100644
--- a/NEWS
+++ b/NEWS
@@ -1 +1,19 @@
-See ChangeLog \ No newline at end of file
+0.5:
+ * Fix line off by one error.
+
+0.4:
+ * Add regexCounter variable for 64 bit values
+ * Fix assertion when selecting text at end of line
+ * Fix problems when large buffers come in at once with multiple lines.
+
+0.3:
+ * Use my real name 'Stefan Walter':
+ See: http://memberwebs.com/nielsen/
+
+0.2:
+ * Fix bug with an assert on long lines
+ * Better configure.in checks.
+ * Cleanup the MIB a bit
+
+0.1:
+ * Initial Release.
diff --git a/autogen.sh b/autogen.sh
index 3ecad27..b4b1261 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -1,6 +1,16 @@
-#!/bin/sh -ex
+#!/bin/sh
-set -ex
+set -e
+
+# Some boiler plate to get git setup as expected
+if test -d .git; then
+ if test -f .git/hooks/pre-commit.sample && \
+ test ! -f .git/hooks/pre-commit; then
+ cp -pv .git/hooks/pre-commit.sample .git/hooks/pre-commit
+ fi
+fi
+
+set -x
aclocal
autoheader