diff options
| -rw-r--r-- | AUTHORS | 9 | ||||
| -rw-r--r-- | README | 2 | ||||
| -rw-r--r-- | doc/HACKING | 56 | ||||
| -rw-r--r-- | doc/Makefile.am | 2 |
4 files changed, 63 insertions, 6 deletions
@@ -1,5 +1,5 @@ Package: gpgme -Maintainer: Marcus Brinkmann <[email protected]> +Maintainer: Werner Koch <[email protected]> Bug reports: [email protected] Security related bug reports: [email protected] License (software): LGPLv2.1+ @@ -7,7 +7,10 @@ License (manual): GPLv3+ FSF <[email protected]> - - Code taken from GnuPG 1.0: gpgme/w32-util.c, GnuPG 1.1: jnlib/. + - Code taken from GnuPG 1.0: src/w32-util.c. + - Other from FSF projects: src/setenv.c, src/vasprintf.c, + src/stpcpy.c, src/w32-ce.c. + g10 Code GmbH <[email protected]> - All stuff since mid march 2001. @@ -19,7 +22,7 @@ Wojciech Polak <[email protected]> - gpgme.spec - Copyright 2001, 2002 g10 Code GmbH + Copyright 2001, 2002, 2012 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 @@ -111,3 +111,5 @@ in the tests/gpg/ directory may also prove useful. Please subscribe to the [email protected] mailing list if you want to do serious work. + +For hacking on GPGME, please have a look at doc/HACKING. diff --git a/doc/HACKING b/doc/HACKING index 6149d25f..aedcf094 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -2,7 +2,8 @@ #+TITLE: Hacking notes for GPGME #+STARTUP: showall -* No more ChangeLog files +* How to contribute +** 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 @@ -12,7 +13,7 @@ be renamed to ChangeLog-2011 -* Commit log requirements +** 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 @@ -26,3 +27,54 @@ Note that ./autogen.sh installs a git hook to do some basic syntax checking on the commit log message. + +** License policy + + GPGME is currently licensed under the LGPLv2.1+ with tools and the + manual being under the GPLv3+. We may eventually update to a newer + version of the licenses or a combination of them. It is thus + important, that all contributed code allows for an update of the + license; for example we can't accept code under the LGPLv2(only). + + If you want to contribute code or documentation to GPGME you are + asked to assert that the contribution is in accordance to the "GPGME + Developer's Certificate of Origin" as found in the file "DCO". + Except for a slight wording change, this DCO is identical to the one + used by the Linux kernel. Please take these simple steps: + + - Decide which mail address you want to use. Please have your real + name in the address and not a pseudonym. Anonymous contributions + can only be done if you find a proxy who certifies for you. + + - If your employer or school might claim ownership of code written + by you; you need to talk to them to make sure that you have the + right to contribute under the DCO. + + - Send an OpenPGP signed mail to the [email protected] public + mailing list from your mail address. Include a copy of the DCO as + found in the official master branch. Insert your name and email + address into the DCO in the same way you want to use it later. + Example: + + Signed-off-by: Joe R. Hacker <[email protected]> + + If you need it, you may perform simple transformations on the mail + address: Replacing "@" by " at " or "." by " dot ".) + + - That's it. From now on you only need to add a "Signed-off-by:" + line with your name and mail address to the GIT commit message. + It is recommended to send the patches using a PGP/MIME signed + mail. + +** Coding standards + + Please follow the GNU coding standards. If you are in doubt consult + the existing code as an example. Do no re-indent code without a + need. If you really need to do it, use a separate commit for such a + change. + +* Debug hints + + - Use gpgme-tool for manual tests. + - The envvar GPGME_DEBUG enables debugging; see debug.[ch] for + details. diff --git a/doc/Makefile.am b/doc/Makefile.am index 93afc062..19b8c828 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -21,7 +21,7 @@ DISTCLEANFILES = gpgme.tmp -EXTRA_DIST = module-overview.sk HACKING ChangeLog-2011 +EXTRA_DIST = module-overview.sk HACKING DCO ChangeLog-2011 info_TEXINFOS = gpgme.texi gpgme_TEXINFOS = uiserver.texi lesser.texi gpl.texi |