aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ChangeLog-2011 (renamed from doc/ChangeLog)19
-rw-r--r--doc/HACKING32
-rw-r--r--doc/Makefile.am2
3 files changed, 42 insertions, 11 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog-2011
index 7dae4ca9b..680affa53 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-01-13 Werner Koch <[email protected]>
* FAQ: Make it a static file with a pointer to the online location.
@@ -139,7 +146,7 @@
* qualified.txt: Add new BnetzA certs 12R and 13R.
* com-certs.pem: Ditto.
- * examples/trustlist.txt: Ditto.
+ * examples/trustlist.txt: Ditto.
2008-06-19 Werner Koch <[email protected]>
@@ -425,7 +432,7 @@
2007-02-18 Werner Koch <[email protected]>
- * gpg.texi (GPG Esoteric Options): No card reader options for gpg2.
+ * gpg.texi (GPG Esoteric Options): No card reader options for gpg2.
2007-02-14 Werner Koch <[email protected]>
@@ -500,7 +507,7 @@
* instguide.texi (Installation): New.
* assuan.texi (Assuan): Removed. Use the libassuan manual instead.
- * gnupg.texi: Reflect these changes.
+ * gnupg.texi: Reflect these changes.
* gpg.texi: Make some parts depend on the "gpgone" set
command. This allows us to use the same source for gpg1 and gpg2.
@@ -655,7 +662,7 @@
* gnupg.texi: Include gpg.texi
* tools.texi: Add a few @command markups.
- * gpgsm.texi: Ditto
+ * gpgsm.texi: Ditto.
* gpg-agent.texi: Ditto.
* scdaemon.texi: Ditto.
@@ -673,7 +680,7 @@
expected pinentry filename.
Changed license of the manual stuff to GPL.
-
+
* gnupg.texi (Top): New menu item Helper Tools.
* tools.texi (Helper Tools): New.
@@ -779,7 +786,7 @@
2002-05-14 Werner Koch <[email protected]>
* Makefile.am, gpgsm.texi: New.
-
+
Copyright 2002, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
This file is free software; as a special exception the author gives
diff --git a/doc/HACKING b/doc/HACKING
index 07f09c56b..e27bc075c 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -3,7 +3,31 @@
(Some notes on GNUPG internals.)
- ===> Under construction <=======
+* No more ChangeLog files
+
+Do not modify any of the ChangeLog files in GnuPG. 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.
+
+
+
+===> What follows is probably out of date <===
+
RFCs
@@ -63,7 +87,7 @@ g10/keydb.h
g10/keyid.c Helper functions to get the keyid, fingerprint etc.
-g10/trustdb.c
+g10/trustdb.c
g10/trustdb.h
g10/tdbdump.c
Management of the trustdb.gpg
@@ -74,7 +98,7 @@ g10/delkey.c Delete a key
g10/kbnode.c Helper for the KBNODE linked list
g10/main.h Prototypes and some constants
g10/mainproc.c Message processing
-g10/armor.c Ascii armor filter
+g10/armor.c Ascii armor filter
g10/mdfilter.c Filter to calculate hashs
g10/textfilter.c Filter to handle CR/LF and trailing white space
g10/cipher.c En-/Decryption filter
@@ -88,7 +112,7 @@ g10/hkp.h Keyserver access
g10/hkp.c
g10/packet.h Defintion of OpenPGP structures.
g10/passphrase.c Passphrase handling code
-g10/pubkey-enc.c
+g10/pubkey-enc.c
g10/seckey-cert.c
g10/seskey.c
g10/import.c
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 2be818e82..4d8e6b373 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -28,7 +28,7 @@ helpfiles = help.txt help.be.txt help.ca.txt help.cs.txt \
help.pt_BR.txt help.ro.txt help.ru.txt help.sk.txt \
help.sv.txt help.tr.txt help.zh_CN.txt help.zh_TW.txt
-EXTRA_DIST = samplekeys.asc \
+EXTRA_DIST = samplekeys.asc ChangeLog-2011 \
gnupg-logo.eps gnupg-logo.pdf gnupg-logo.png \
gnupg-card-architecture.eps gnupg-card-architecture.png \
gnupg-card-architecture.pdf \