diff options
author | Werner Koch <[email protected]> | 2011-12-02 10:32:31 +0000 |
---|---|---|
committer | Werner Koch <[email protected]> | 2011-12-02 10:36:37 +0000 |
commit | a4c4ee1aaea4359432bdf60dd572f549ef8dee83 (patch) | |
tree | 479a4c6baca2d581bfbd5f195d80b7255fd5ad38 /doc | |
parent | Remove support for libgpgme-pth. (diff) | |
download | gpgme-a4c4ee1aaea4359432bdf60dd572f549ef8dee83.tar.gz gpgme-a4c4ee1aaea4359432bdf60dd572f549ef8dee83.zip |
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.
* build-aux/git-hook/commit-msg: New script.
* 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) | 16 | ||||
-rw-r--r-- | doc/HACKING | 28 | ||||
-rw-r--r-- | doc/Makefile.am | 10 |
3 files changed, 45 insertions, 9 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog-2011 index 1dce16b5..d6ecca77 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog-2011 @@ -1,3 +1,10 @@ +2011-12-02 Werner Koch <[email protected]> + + 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-05-12 Marcus Brinkmann <[email protected]> * gpgme.texi (I/O Callback Example): Fix example code. @@ -605,7 +612,7 @@ (Manipulating Data Buffers): Update interfaces. Add gpgme_data_seek. * gpgme.texi (Engine Version Check): Remove gpgme_check_engine. - + 2002-11-21 Marcus Brinkmann <[email protected]> * gpgme.texi (Verify): Document the new interface. @@ -742,7 +749,7 @@ * gpgme.texi (direntry): End index entry with a full stop. Patch submitted by Jose Carlos Garcia Sogo <[email protected]>. - + 2002-03-17 Marcus Brinkmann <[email protected]> * gpgme.texi (Detailed Results): Fix syntax error in last change. @@ -857,7 +864,7 @@ * gpgme.texi: g10Code -> g10 Code * gpgme.texi (Top): Complete detailmenu. - + * gpgme.texi: Convert embarassing cruft to the real thing. 2002-01-16 Marcus Brinkmann <[email protected]> @@ -869,7 +876,8 @@ * Makefile.am (info_TEXINFOS): New variable. (gpgme_TEXINFOS): Likewise. - Copyright 2002, 2003, 2004 g10 Code GmbH + Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, + 2011 g10 Code GmbH This file is free software; as a special exception the author gives unlimited permission to copy and/or distribute it, with or without diff --git a/doc/HACKING b/doc/HACKING new file mode 100644 index 00000000..6149d25f --- /dev/null +++ b/doc/HACKING @@ -0,0 +1,28 @@ +# HACKING -*- org -*- +#+TITLE: Hacking notes for GPGME +#+STARTUP: showall + +* No more ChangeLog files + + Do not modify any of the ChangeLog files in GPGME. 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. + + Note that ./autogen.sh installs a git hook to do some basic syntax + checking on the commit log message. diff --git a/doc/Makefile.am b/doc/Makefile.am index 212216dc..93afc062 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,18 +1,18 @@ # doc - Automake template # Copyright (C) 2001, 2004 g10 Code GmbH -# +# # This file is part of GPGME. -# +# # GPGME is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as # published by the Free Software Foundation; either version 2.1 of the # License, or (at your option) any later version. -# +# # GPGME is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General # Public License for more details. -# +# # You should have received a copy of the GNU Lesser General Public # License along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA @@ -21,7 +21,7 @@ DISTCLEANFILES = gpgme.tmp -EXTRA_DIST = module-overview.sk +EXTRA_DIST = module-overview.sk HACKING ChangeLog-2011 info_TEXINFOS = gpgme.texi gpgme_TEXINFOS = uiserver.texi lesser.texi gpl.texi |