diff options
| author | Werner Koch <wk@gnupg.org> | 2011-12-01 22:53:03 +0100 |
|---|---|---|
| committer | Werner Koch <wk@gnupg.org> | 2011-12-01 22:53:03 +0100 |
| commit | 165a57d29d2ac84159aa48b171b6098c629bc798 (patch) | |
| tree | ab27496fa66267a528333e2bb8f99077d57b0601 /doc | |
| parent | 2e037baefdc40da6961721ad56fc7c38d4e492a8 (diff) | |
| download | libassuan-165a57d29d2ac84159aa48b171b6098c629bc798.tar.gz | |
Generate the ChangeLog from commit logs.
* build-aux/gitlog-to-changelog: New script. Taken from gnulib.
* build-aux/git-log-fix: New file.
* build-aux/git-log-footer: New file.
* doc/HACKING: New file.
* ChangeLog: New file.
* Makefile.am (EXTRA_DIST): Add new files.
(gen-ChangeLog): New.
(dist-hook): Run gen-ChangeLog.
* autogen.sh: Install commit-msg hook for git.
Rename all ChangeLog files to ChangeLog-2011.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog-2011 (renamed from doc/ChangeLog) | 10 | ||||
| -rw-r--r-- | doc/HACKING | 25 | ||||
| -rw-r--r-- | doc/Makefile.am | 2 |
3 files changed, 34 insertions, 3 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog-2011 index 5e1e198..4f8b568 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. + 2009-12-08 Marcus Brinkmann <marcus@g10code.de> * assuan.texi: Use our own copy of the setfont macro, as it takes @@ -100,7 +107,7 @@ 2007-07-05 Werner Koch <wk@g10code.com> - * lgpl.texi: New. Taken from COPYING.LIB and reformatted. + * lgpl.texi: New. Taken from COPYING.LIB and reformatted. * gpl.texi: Updated to v3. * assuan.texi (Utilities): Explain ASSUAN_CONFIDENTIAL. @@ -145,4 +152,3 @@ 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. - diff --git a/doc/HACKING b/doc/HACKING new file mode 100644 index 0000000..b7d6b10 --- /dev/null +++ b/doc/HACKING @@ -0,0 +1,25 @@ +# HACKING -*- org -*- +#+TITLE: Hacking notes for Libassuan +#+STARTUP: showall + +* No more ChangeLog files + + Do not modify any of the ChangeLog files in Libassuan. 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. diff --git a/doc/Makefile.am b/doc/Makefile.am index daea6e0..cc41a78 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -18,7 +18,7 @@ ## Process this file with automake to produce Makefile.in -EXTRA_DIST = README.apichanges +EXTRA_DIST = README.apichanges HACKING info_TEXINFOS = assuan.texi |