summaryrefslogtreecommitdiff
path: root/devel.html
blob: c3277afc7291affab4ee6560fb12f5dfcf8b1791 (plain)
1
2
3
4
5
6
7
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="icon" type="image/png" href="graphics/gnutls-logo-icon.png">
<meta name="DC.title" content="gnutls.org">
<title>GnuTLS</title>
<!-- start of banner.html -->
<!-- start of head-include-2.html -->
<link rel="stylesheet" href="css/combo.css" media="screen">
<link rel="stylesheet" href="css/layout.css" media="screen">
<link rel="stylesheet" href="css/mini.css" media="handheld">
<link rel="stylesheet" href="css/print.css" media="print">
<!-- end of head-include-2.html -->
</head>
<body>
<!--<div id="null-wrapper"> -->
<!-- begin of body-include-2 -->
      <div id="header">
        <div class="inner" style="position: relative;">
<table width="100%" class="transparent" summary="">
	<tr><td>
		<a href="gnutls-logo.html">
		<img alt="Gnutls Logo" src="graphics/gnutls-logo.png" align="Left" border="0" width="94" height="86">
		</a>
	</td>
	<td>
		<h1>The GnuTLS Transport Layer Security Library</h1>
	</td>
	</tr>
	</table>
	</div>
      </div>
<div id="navigation">
 <div class="inner">
  <ul>
   <li id="tab"><a href="index.html">Overview</a></li>
   <li id="tab"><a href="news.html">News</a></li>
<!-- <li id="tab"><a href="soc.html">Summer of code</a></li>
 -->
   <li id="tab"><a href="download.html">Download</a></li>
   <li id="tab"><a href="support.html">Support</a></li>
   <li id="joinfsftab"><a href="devel.html">Development</a></li>
   <li id="tab"><a href="documentation.html">Documentation</a></li>
   <li id="tab"><a href="security.html">Security advisories</a></li>
<!-- <li id="tab"><a href="commercial.html">Commercial support</a></li>
-->
   <li id="tab"><a href="contrib.html">Authors</a></li>
</ul>
 </div><!-- /inner -->
</div><!-- /navigation -->
<div id="content" class="inner">
<h1>Reporting bugs</h1>
To report a bug, in addition to describing the issue, please:
<ul>
<li>Provide the version of the library the bug is present on (the oldest supported release is 3.3.x), and try to detect the version the bug was introduced, e.g., using git-bisect.</li>
<li>Provide a way to reproduce the issue; e.g., a small program which reproduces it.</li>
<li>Use <a href="https://gitlab.com/gnutls/gnutls/issues">our issue tracker</a>
or the <a href="mailto:bugs@gnutls.org">bug report address</a> for non-public issues.</li>
</ul>
That would help us to address your issue.
<h1>API and ABI</h1>
<p>
Our goal is to deliver a stable API and ABI for the library, but on certain
major releases we have decided to break the ABI in order to deprecate old APIs and avoid clutter.
To ensure API and ABI stability we rely on abi-compliance-checker and other tools, and we maintain
an <a href="abi-tracker/timeline/gnutls/index.html">ABI tracker page for gnutls</a> which visualises
the output of these tools.
<ul>
<li><a href="abi-tracker/timeline/gnutls/index.html">ABI tracker report</a></li>
</ul>
</p>
<h1>Development</h1>
<p>To follow development it is easier to subscribe <a href="support.html">on the mailing lists</a>; the <a href="https://gitlab.com/gnutls/gnutls/wikis/home">wiki pages</a>
may also contain information on new developments and plans.
To browse the source code a web interface exists at <a href="https://gitlab.com/gnutls/gnutls/">gitlab.com</a>.
If you want to build the latest GnuTLS code from the repository, use the following commands:
</p>
<table summary="">
<tr><td><pre>
$ git clone https://gitlab.com/gnutls/gnutls.git
$ cd gnutls
$ git submodule update --init
$ make bootstrap # Will generate ./configure script
$ ./configure --enable-gcc-warnings --enable-gtk-doc --enable-gtk-doc-pdf
$ make
$ make check
</code></td></tr>
</table>

<p>You will need several developer tools, which are listed in
<a href="https://gitlab.com/gnutls/gnutls/blob/master/README-alpha.md">
README-alpha</a>.
</p>

<p>If you wish to contribute, you may read more about 
<a href="https://gitlab.com/gnutls/gnutls/blob/master/CONTRIBUTING.md">
our coding style</a>. 
Note that when contributing code that is not assigned to FSF, you will need to
assert that the contribution is in accordance to the <a href="https://gitlab.com/gnutls/gnutls/blob/master/doc/DCO.txt">Developer's
Certificate of Origin</a>. That can be done by sending a mail with your real name that contains
the DCO 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.
</p>


<p>Some additional resources:
<ul>
<li><a href="https://gitlab.com/gnutls/gnutls/blob/master/NEWS">most recent NEWS</a></li>
<!-- <li><a href="http://hydra.nixos.org/jobset/gnu/gnutls-master">Continously Hydra builds</a></li>-->
</ul>

<!--
<p>
<script type="text/javascript"
src="http://www.ohloh.net/p/5718/widgets/project_basic_stats.js"></script>
</p>
-->

</div>

<!-- <p id="backtotop"><a href="#header">back to top</a></p>  -->
 
</div> 
<!-- end server/footer-text.html --> 
 
 
<div id="footer"> 
 
<table width="100%" class="transparent" summary="">
<tr>
<td>
<p>
Please send broken links and other corrections or suggestions to
<a href="mailto:bugs@gnutls.org"><em>bugs@gnutls.org</em></a>.
</p>
<!--
<p>
Copyright © 2011-2015 Free Software Foundation, Inc.<br>
Copyright © 2012-2015 Nikos Mavrogiannopoulos<br>
Verbatim copying and distribution of this entire article are permitted worldwide, without royalty, in any medium, provided this notice, and the copyright notice, are preserved.<br>
</p>
-->
</td>
<!--
<td>
<a href="http://flattr.com/thing/291598/GnuTLS" target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>

  <form action="https://www.paypal.com/cgi-bin/webscr" method="post">
      <input type="hidden" name="cmd" value="_xclick">
      <input type="hidden" name="business" value="simon@josefsson.org">
      <input type="hidden" name="item_name" value="Donation for development">
      <input type="hidden" name="item_number" value="GnuTLS">
      <input type="hidden" name="no_shipping" value="1">
      <input type="hidden" name="cn" value="Comment">
      <input type="hidden" name="currency_code" value="EUR">
      <input type="hidden" name="tax" value="0">
      <input type="hidden" name="bn" value="PP-DonationsBF">
      <input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" name="submit" alt="Paypal">
  </form>
  </div>

</td>
-->

</tr>
</table>

</div> 
 
</body>
</html>