diff options
author | Werner Koch <wk@gnupg.org> | 2011-12-01 14:20:31 +0100 |
---|---|---|
committer | Werner Koch <wk@gnupg.org> | 2011-12-01 14:20:31 +0100 |
commit | 137d73191c904926ba529376144ee8239af4ca02 (patch) | |
tree | a6b88025bcaede620ef8d1f4e4fae8ae81744ec7 /doc/HACKING | |
parent | 5a1b2784cc1a718fd44d551b7ec018ef4614ce30 (diff) | |
download | libgcrypt-137d73191c904926ba529376144ee8239af4ca02.tar.gz |
Generate the ChangeLog from commit logs.
* scripts/gitlog-to-changelog: New script. Taken from gnulib.
* scripts/git-log-fix: New file.
* scripts/git-log-footer: New file.
* doc/HACKING: Describe the ChangeLog policy
* ChangeLog: New file.
* Makefile.am (EXTRA_DIST): Add new files.
(gen-ChangeLog): New.
(dist-hook): Run gen-ChangeLog.
Rename all ChangeLog files to ChangeLog-2011.
Diffstat (limited to 'doc/HACKING')
-rw-r--r-- | doc/HACKING | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/HACKING b/doc/HACKING index 3f94772c..4e0405d1 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -1,6 +1,30 @@ Various hacking notes -*- text -*- ======================= +No more ChangeLog files +----------------------- + +Do not modify any of the ChangeLog files in Libgcrypt. Starting on +December 1st, 2011 we put change information only in the GIT commit +log, and generate a top-level ChangeLog file from logs at "make dist" +time. As such, there are strict requirements on the form of the +commit log messages. The old ChangeLog files have all be renamed to +ChangeLog-2011 + + +Commit log requirements +----------------------- + +Your 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. However, it's fine -- even recommended -- +to write a few lines of prose describing the change, when the summary +and ChangeLog entries don't give enough of the big picture. Omit the +leading TABs that you're used to seeing in a "real" ChangeLog file, but +keep the maximum line length at 72 or smaller, so that the generated +ChangeLog lines, each with its leading TAB, will not exceed 80 columns. + + Taking optimized MPI code out of GMP: ------------------------------------- |