diff options
| author | Kim Phillips <kim.phillips@linaro.org> | 2013-07-31 13:11:48 -0500 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2013-12-25 01:32:03 +0400 |
| commit | b776f4ac6fb442451e8075db9a9ec488b5a44616 (patch) | |
| tree | b6b619b95b350584cd821f8247b161859efa37ca /CONTRIBUTING | |
| parent | 5e1ecbc765319de3027ef00ebce7995fe967c4eb (diff) | |
odp: add license and contribution instructions
License is 3-clause BSD, taken verbatim from [1] with:
{OWNER,ORGANIZATION} = "Linaro Limited"
YEAR = 2013
Contributions should for the most part mirror upstream linux kernel
coding style and development practices.
[1] http://opensource.org/licenses/BSD-3-Clause
Signed-off-by: Kim Phillips <kim.phillips@linaro.org>
Diffstat (limited to 'CONTRIBUTING')
| -rw-r--r-- | CONTRIBUTING | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..b3a9095 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,43 @@ +Contributing to the Open Dataplane API (ODP) + +The Open Dataplane API follows the linux kernel coding style [1] and code +submission process [2], albeit patch submissions are to be submitted to the +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: + +checkpatch: + +git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git + +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 + +[TODO: update for cross-building, endianness checks] + +(c) Prior to submission, to style-check the patch 'file.patch', run: + +${PATH_TO_LINUX}/scripts/checkpatch.pl --no-tree --strict 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] https://groups.google.com/a/linaro.org/forum/#!forum/linaro-networking +[4] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/sparse.txt |