summaryrefslogtreecommitdiff
path: root/README-hacking
diff options
context:
space:
mode:
authorDmitry V. Levin <ldv@altlinux.org>2009-07-09 00:47:41 +0000
committerDmitry V. Levin <ldv@altlinux.org>2009-07-08 21:01:21 +0000
commit08f922a574ceed1cc092b79a5aa6a46c2925cd0d (patch)
tree37c4acb6027e67a8a5c5ddd3cafd0b0a7d883b83 /README-hacking
parent414fe7d4d284e22d7855c5367f17dbc0714738d9 (diff)
downloadstrace-08f922a574ceed1cc092b79a5aa6a46c2925cd0d.tar.gz
strace-08f922a574ceed1cc092b79a5aa6a46c2925cd0d.tar.bz2
strace-08f922a574ceed1cc092b79a5aa6a46c2925cd0d.tar.xz
Generate ChangeLog from git log
* .gitignore: Add ChangeLog * ChangeLog: Rename to ChangeLog-CVS. * Makefile.am (gen-changelog): New rule. (dist-hook): Depend on it. (EXTRA_DIST): Add ChangeLog-CVS. * README-hacking: Describe changes. * gitlog-to-changelog: Import from gnulib. Signed-off-by: Dmitry V. Levin <ldv@altlinux.org>
Diffstat (limited to 'README-hacking')
-rw-r--r--README-hacking21
1 files changed, 20 insertions, 1 deletions
diff --git a/README-hacking b/README-hacking
index af2a1f6..becff13 100644
--- a/README-hacking
+++ b/README-hacking
@@ -1,5 +1,24 @@
-
+Requirements
+============
If you use the GIT version of strace there will be some files missing
that you need to build strace. These files are generated by tools from
the GNU Autoconf and Automake packages. You need recent versions, which
provide the `autoreconf -i' command that will do everything you need.
+
+
+No more ChangeLog file
+======================
+Do not create or modify the ChangeLog files. Starting at 2009-07-09, the
+policy changed. Before, we would insert the exact same text (or worse,
+sometimes slightly differing) into both the ChangeLog file and the commit
+log. Now we put that information only in the commit log, and generate
+the top-level ChangeLog file from logs at "make dist" time. As such,
+there are strict requirements on the form of the commit log messages.
+
+
+Commit log requirements
+=======================
+Each commit log should always start with a one-line summary, the second
+line should be blank, and the remaining lines are usually ChangeLog-style
+entries for all affected files, except the leading TABs which should
+be omitted.