CONTRIBUTING


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

	Contributing to the OpenDataplane (ODP) API

  The ODP API follows the linux kernel coding style [1] and code submission
process [2], albeit patch submissions are to be submitted to the ODP
linaro-networking mailing list [3] (not LKML, etc.).

  To certify you wrote the code, or otherwise have the right to pass it
on (presumably from a compatibly licensed project), we use the "Developer's
Certificate of Origin" (see [2]).  Using this sign-off process, we are able to
keep track of compliance to our license (see LICENSE file).

  There are tools we use to maintain CodingStyle and other good programming
practice consistency, including type-checking without overuse of casts.

(a) perform a one-time setup for the tools:

semantic parser 'sparse' [4]:

	git clone git://git.kernel.org/pub/scm/devel/sparse/sparse.git
	cd sparse
	make
	export PATH=$PATH:$PWD

(b) when building, use sparse to check for stricter type checking than the
compiler:

	make CC=cgcc

(c) create patches with git:
	git format-patch --subject-prefix="PATCH"  --find-renames HEAD^
	For prefixes see [3].

(d) Prior to submission, to style-check the patch 'file.patch', run:

	./scripts/checkpatch.pl file.patch

[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle
[2] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches
[3] refer to README file.
[4] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/sparse.txt