diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ChangeLog-2011 (renamed from doc/ChangeLog) | 11 | ||||
-rw-r--r-- | doc/HACKING | 24 |
2 files changed, 35 insertions, 0 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog-2011 index 1b23647c..de837a05 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog-2011 @@ -1,3 +1,10 @@ +2011-12-01 Werner Koch <wk@g10code.com> + + NB: ChangeLog files are no longer manually maintained. 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". See doc/HACKING for details. + 2011-09-15 Werner Koch <wk@g10code.com> * gcrypt.texi: Remove the gcry_ac interface @@ -475,3 +482,7 @@ Wed Feb 10 17:15:39 CET 1999 Werner Koch <wk@isil.d.shuttle.de> This file is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, to the extent permitted by law; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + +Local Variables: +buffer-read-only: t +End: 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: ------------------------------------- |