README.md 4.34 KB
Newer Older
1 2
GnuTLS README-alpha -- Information for developers
=================================================
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
3 4

This file contains instructions for developers and advanced users that
5
want to build from version controlled sources.
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
6

7
We require several tools to check out and build the software, including:
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
* Make <http://www.gnu.org/software/make/>
* Automake <http://www.gnu.org/software/automake/> (use 1.11.3 or later)
* Autoconf <http://www.gnu.org/software/autoconf/>
* Autogen <http://www.gnu.org/software/autogen/> (use 5.16 or later)
* Libtool <http://www.gnu.org/software/libtool/>
* Gettext <http://www.gnu.org/software/gettext/>
* Texinfo <http://www.gnu.org/software/texinfo/>
* Tar <http://www.gnu.org/software/tar/>
* Gzip <http://www.gnu.org/software/gzip/>
* Texlive & epsf <http://www.tug.org/texlive/> (for PDF manual)
* CVS <http://www.gnu.org/software/cvs/> (for gettext autopoint)
* GTK-DOC <http://www.gtk.org/gtk-doc/> (for API manual)
* Git <http://git-scm.com/>
* Perl <http://www.cpan.org/>
* Nettle <http://www.lysator.liu.se/~nisse/nettle/>
* Guile <http://www.gnu.org/software/guile/>
* p11-kit <http://p11-glue.freedesktop.org/p11-kit.html>
* gperf <http://www.gnu.org/software/gperf/>
* libtasn1 <http://josefsson.org/libtasn1/> (optional)
* datefudge <http://packages.debian.org/datefudge> (optional)
* Libidn <http://www.gnu.org/software/libidn/> (optional, for internationalization of DNS)
* AWK <http://www.gnu.org/software/awk/> (for make dist, pmccabe2html)
* git2cl <http://savannah.nongnu.org/projects/git2cl/> (for make dist, ChangeLog)
* softhsm <http://www.opendnssec.org/softhsm/> (for testing smart card support)
* dieharder <http://www.phy.duke.edu/~rgb/General/dieharder.php> (for testing PRNG)
* bison <http://www.gnu.org/software/bison> (for datetime parser in certtool)
* libunbound <https://unbound.net/> (for DANE support)
* nodejs <http://nodejs.org/> (needed for certain test cases)
* abi-compliance-checker <http://ispras.linuxbase.org/index.php/ABI_compliance_checker> (for make dist)
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
38

39
The required software is typically distributed with your operating
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
40 41 42 43
system, and the instructions for installing them differ.  Here are
some hints:

gNewSense/Debian/Ubuntu:
44
```
Simon Josefsson's avatar
Simon Josefsson committed
45
apt-get install git-core autoconf libtool gettext autopoint
46 47
apt-get install texinfo texlive texlive-generic-recommended texlive-extra-utils
apt-get install help2man gtk-doc-tools valgrind
48
apt-get install guile-2.0-dev libtasn1-6-dev
49 50
apt-get install libidn11-dev gawk gperf
apt-get install libunbound-dev dns-root-data bison
51
apt-get install automake autogen nettle-dev libp11-kit-dev
52
```
53

54 55 56 57 58 59
Sometimes, you may need to install more recent versions of Automake,
Nettle, P11-kit and Autogen, which you will need to build from sources. 

Dependencies that are used during make check:
* Valgrind <http://valgrind.org/> (optional)
* Libasan <https://gcc.gnu.org//> (optional)
60

61
```
62
apt-get install valgrind libasan1
63
```
64 65

For basic interoperability testing you may want to install openssl
66
and polarssl. The packages below are used during make check.
67

68
```
69
apt-get install libpolarssl-runtime openssl
70
apt-get install nodejs softhsm datefudge
71
```
72

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
73 74
To download the version controlled sources:

75
```
Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
76
$ git clone git://gitorious.org/gnutls/gnutls.git
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
77
$ cd gnutls
78
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
79

Simon Josefsson's avatar
Simon Josefsson committed
80
The next step is to run autoreconf (etc) and then ./configure:
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
81

82
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
83
$ make bootstrap
84
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
85

Simon Josefsson's avatar
Simon Josefsson committed
86 87 88
When built this way, some developer defaults will be enabled.  See
cfg.mk for details.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
89 90
Then build the project normally:

91
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
92 93
$ make
$ make check
94
```
Simon Josefsson's avatar
Add.  
Simon Josefsson committed
95

96 97
Individual tests that may require additional hardware (e.g., smart cards)
are:
98
```
99
$ sh tests/suite/testpkcs11
100
```
101

Nikos Mavrogiannopoulos's avatar
updated  
Nikos Mavrogiannopoulos committed
102 103 104 105 106 107 108 109 110
If you wish to contribute, you may read more about our coding style in
doc/README.CODING_STYLE. Note that when contributing code that is not 
assigned to FSF, you will need to assert that the contribution is in 
accordance to the "Developer's Certificate of Origin" as found in the 
file doc/DCO.txt. That can be done by sending a mail with your real name to 
the gnutls-devel mailing list. Then just make sure that your contributions 
(patches), contain a "Signed-off-by" line, with your name and e-mail address. 
To automate the process use "git am -s" to produce patches.

Simon Josefsson's avatar
Add.  
Simon Josefsson committed
111 112 113 114 115 116
Happy hacking!

----------------------------------------------------------------------
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.