bti.xml: docsheet url cleanup
[gregoa/bti.git] / HACKING
1 Patches are gladly accepted for bti code, please send them to
2 greg@kroah.com, or you can use github to send a pull request.
3
4 The code tree for bti is located at:
5         http://github.com/gregkh/bti
6 and can be cloned using git from:
7         git://github.com/gregkh/bti.git
8
9 If you have never used git before, there are some useful tutorials on
10 the github.com web site to help you through the learning process.
11
12 I am trying to follow the Linux kernel coding style with the code
13 wherever possible.  This style is documented in the Linux kernel source
14 tree in the file Documentation/CodingStyle.  Included in the bti code
15 tree is a script called checkpatch.pl that can automatically check if
16 your changes are compliant with the guidelines.
17
18 To test this, using git, generate a patch:
19         git diff > my_patch
20 Then run checkpatch.pl against this patch:
21         ./scripts/checkpatch.pl --no-tree my_patch
22
23
24 Please run your modifications through valgrind if possible.  It is safe
25 to ignore the valgrind errors in the curl and ssl libraries, we can't do
26 anything about those at this time.