diff options
Diffstat (limited to 'doc/HACKING')
-rw-r--r-- | doc/HACKING | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/HACKING b/doc/HACKING index eee9f628b..37ebdc921 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -3,30 +3,41 @@ (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. -CVS Access -========== -NOTE: CVS access has been disabled while we are migrating to Subversion. -Watch www.gnupg.org for instarctions on how to use the Subversion repository. -Anonymous read-only CVS access is available: + ===> Under construction <======= + - cvs -z3 -d :pserver:[email protected]:/cvs/gnupg login +GIT Access +========== -use the password "anoncvs". To check out the the complete -archive use: +The GIT repository is available at: - cvs -z3 -d :pserver:[email protected]:/cvs/gnupg \ - checkout -R STABLE-BRANCH-1-0 gnupg + git clone git://git.gnupg.org/gnupg.git + git checkout STABLE-BRANCH-1-4 -This service is provided to help you in hunting bugs and not to deliver -stable snapshots; it may happen that it even does not compile, so please -don't complain. CVS may put a high load on a server, so please don't poll -poll for new updates but wait for an announcement; to receive this you may -want to subscribe to: +You may want to subscribe to: @@ -36,8 +47,8 @@ by sending a mail with subject "subscribe" to You must run scripts/autogen.sh before doing the ./configure, -as this creates some needed while which are not in the CVS. -autogen.sh should checks that you have all required tools +as this creates some needed while which are not in the repository. +autogen.sh should check that you have all required tools installed. @@ -49,17 +60,6 @@ of the CVS head revision is also available. See rsync(1) and try -Special Tools -============= -Documentation is based on the docbook DTD. Actually we have only the -man page for now. To build a man page you need the docbook-to-man -tool and all the other thinks needed for SGML processing. Debian -comes with the docbook tools and you only need this docbook-to-man -script which is comes with gtk-doc or download it from -ftp.openit.de:/pub/devel/sgml. If you don't have it everything -should still work fine but you will have only a dummy man page. - - RFCs ==== @@ -78,7 +78,7 @@ RFCs 2279 UTF-8, a transformation format of ISO 10646. -2440 OpenPGP. +4880 OpenPGP (replaces by 2440). @@ -138,7 +138,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 @@ -149,7 +149,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 @@ -163,7 +163,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 |