summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2012-04-20 09:45:04 +0200
committerWerner Koch <wk@gnupg.org>2012-04-20 09:45:04 +0200
commit861d19e028af70c7009640efc98eb485fff546d7 (patch)
treeeca6ded32ebb9b0d0fb53c0038cb3e8a8591e97b /doc
parent5c00c7cc2901a879927a5756e1bb7ecf49439ebc (diff)
downloadlibassuan-861d19e028af70c7009640efc98eb485fff546d7.tar.gz
State new contribution rules.
* doc/DCO: New. * doc/HACKING: Doument new rules. Give examples for commit logs.
Diffstat (limited to 'doc')
-rw-r--r--doc/DCO29
-rw-r--r--doc/HACKING89
-rw-r--r--doc/Makefile.am2
3 files changed, 117 insertions, 3 deletions
diff --git a/doc/DCO b/doc/DCO
new file mode 100644
index 0000000..2809566
--- /dev/null
+++ b/doc/DCO
@@ -0,0 +1,29 @@
+Libassuan Developer's Certificate of Origin. Version 1.0
+=========================================================
+
+By making a contribution to the Libassuan project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+ have the right to submit it under the free software license
+ indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the
+ best of my knowledge, is covered under an appropriate free
+ software license and I have the right under that license to
+ submit that work with modifications, whether created in whole
+ or in part by me, under the same free software license
+ (unless I am permitted to submit under a different license),
+ as indicated in the file; or
+
+(c) The contribution was provided directly to me by some other
+ person who certified (a), (b) or (c) and I have not modified
+ it.
+
+(d) I understand and agree that this project and the contribution
+ are public and that a record of the contribution (including
+ all personal information I submit with it, including my
+ sign-off) is maintained indefinitely and may be redistributed
+ consistent with this project or the free software license(s)
+ involved.
+
+Signed-off-by: [Your name and mail address]
diff --git a/doc/HACKING b/doc/HACKING
index b7d6b10..0e32f58 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -2,7 +2,12 @@
#+TITLE: Hacking notes for Libassuan
#+STARTUP: showall
-* No more ChangeLog files
+* How to contribute
+
+ The following stuff explains some basic procedures you need to
+ follow if you want to contribute code or documentation.
+
+** 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
@@ -12,7 +17,14 @@
be renamed to ChangeLog-2011
-* Commit log requirements
+** 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. See below for the required commit log format.
+
+** 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
@@ -23,3 +35,76 @@
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.
+
+ Here is an example of a commit message:
+#+begin_example
+Make new functions also visible on non-W32.
+
+* src/system-posix.c (__assuan_read, __assuan_write, __assuan_recvmsg)
+(__assuan_sendmsg, __assuan_waitpid): Make functions global.
+* src/libassuan.vers: Add above functions.
+* configure.ac: Set version to 2.1.0-git.
+--
+Note that everything after the above tear off marker will not be
+copied to the ChangeLog during a "make dist". You may use this to add
+extra information about this commit which are mostly relevant for your
+co-hackers. Recall that the ChangeLog itself fulfills requirements of
+the GPL and is useful for quick history checks of a released version.
+Developers will use the git log.
+#+end_example
+
+ If you don't want a ChangeLog entry at all, use this:
+#+begin_example
+Give examples for commit logs.
+
+--
+Because the tear off line is the first line of the body, not even the
+summary line will be copied to the ChangeLog. Using only the tear off
+line without any text is often useful for commits like "Typo and
+grammar fixes."
+#+end_example
+
+
+** License policy
+
+ Libassuan is currently licensed under the LGPLv2+ 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; in particular we can't accept code under the GPL or LGPL
+ without the "or any later version" term.
+
+ Being developed as part of GnuPG-2, Libassuan used to have a strict
+ policy of requiring copyright assignments to the FSF. To avoid this
+ major organizational overhead and to allow inclusion of code, not
+ copyrighted by the FSF, this policy has been relaxed. It is now
+ also possible to contribute code by asserting that the contribution
+ is in accordance to the "Libassuan 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.)
+
+ If your want to contribute code or documentation to Libassuan and
+ you didn't signed a copyright assignment with the FSF in the past,
+ you need to 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 gnupg-devel@gnupg.org 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 <joe@example.org>
+
+ (If you really need it, you may perform simple transformations of
+ 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 commit message. It is
+ recommended to send the patches using a PGP/MIME signed mail.
diff --git a/doc/Makefile.am b/doc/Makefile.am
index cc41a78..6229ddc 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 HACKING
+EXTRA_DIST = README.apichanges HACKING DCO
info_TEXINFOS = assuan.texi