blob: b069e071237cae9fd90d42123fd7fd36716d344d (
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
|
Please feel free to contribute patches; here are the basic guidelines to hack
along with us!
Please work from a git tree by cloning the repo:
git clone https://github.com/ioerror/tlsdate.git
Please file bugs on the tlsdate issue tracker:
https://github.com/ioerror/tlsdate/issues
Please use the github pull request feature when possible.
The current build status is available as a handy image:
[](http://travis-ci.org/ioerror/tlsdate)
Continuous integration is available for a number of platforms:
https://jenkins.torproject.org/job/tlsdate-ci-linux/
https://travis-ci.org/ioerror/tlsdate
http://build.chromium.org/p/chromiumos/waterfall
White Space:
Spaces only, no tabs; all tabs must die
No stray spaces at the end of lines
Generally try not to add excessive empty white space
Documentation:
Document all functions with doxygen style comments
Ensuring Correctness:
Test your patches and ensure:
No compiler warnings or errors
No linker warnings or errors
Test your improved copy of tlsdate extensively
Security:
tlsdate is security sensitive - please consider where you add code and in
what context it will run. When possible, run with the least privilege as is
possible.
Proactively find bugs:
Run your copy of tlsdate under valgrind
Weird but meaningful conventions are prefered in tlsdate. We prefer attention
to detail:
if ( NULL == foo (void) )
{
bar (void);
}
Over quick, hard to read and potentilly incorrect:
if (foo(void)==NULL))
bar();
Define magic numbers and explain their origin:
// As taken from RFC 3.14
#define MAGIC_NUMBER 23 // This goes in foo.h
ptr = malloc (MAGIC_NUMBER);
Rather than just throwing them about in code:
ptr = malloc (23);
It is almost always prefered to use dynamically allocated memory:
widget_ptr = malloc (WIDGET_SIZE);
Try to avoid static allocations like the following:
char widget[WIDGET_SIZE];
Try to use unsigned values unless an API requires signed values:
uint32_t server_time_s;
Please provide relevant CHANGELOG entries for all changes.
Please remove items from the TODO file as they are completed.
Please provide unittest cases.
When submitting patches via email, please use `git format-patch` to format
patches:
git format-patch 9a61fcba9bebc3fa2d91c9f79306bf316c59cbcc
Email patches with a GnuPG signature whenever possible.
When applying patches, please use `git am` to apply patches:
git am -i 0001-add-TODO-item.patch
If `git format-patch` is not possible, please send a unified diff.
When in doubt, please consult the Tor HACKING guide:
https://gitweb.torproject.org/tor.git/blob/HEAD:/doc/HACKING
|
