From: Emil Velikov Date: Mon, 16 Sep 2024 10:18:39 +0000 (+0100) Subject: CONTRIBUTING.md: mention s-o-b tag, includ DCO copy X-Git-Tag: v34~349 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=019c1bc27dac07252ca0d5aae7c8507991f38119;p=thirdparty%2Fkmod.git CONTRIBUTING.md: mention s-o-b tag, includ DCO copy While CODING-STYLE states that using Signed-off-by is an error, a large number of contributors have been using it. Most, if not all, of those are people who have contributed to the kernel, and by extension know about the DCO. So let's add an in-tree copy of the file, explicitly document what is meant with the tag (other projects use if for different purposes) and drop the note from CODING-STYLE. I have not went full bananas to require it, since based on the numbers below, majority of commits lack it. We could reconsider that at later point, if needed. Numbers, as of commit 11ccabd ("libkmod: document the symbols file") - total number of commits - 1640 - number of commits with at least one s-o-b - 357 - this can be s-o-b by the author, maintainer and/or both - total number of contributors (bots including) - 109 - number of individuals with at least one s-o-b - 42 v2 - drop html bits from DCO - tag -> trailer Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/134 Signed-off-by: Lucas De Marchi --- diff --git a/CODING-STYLE b/CODING-STYLE index cab2b360..2cff255a 100644 --- a/CODING-STYLE +++ b/CODING-STYLE @@ -9,11 +9,9 @@ First of all, kmod coding style must follow every rule for Linux kernel (http://www.kernel.org/doc/Documentation/CodingStyle). There also exists a tool named checkpatch.pl to help you check the compliance with it. Just type "checkpatch.pl --no-tree patch_name" to check your patch. In theory, you need -to clean up all the warnings and errors except this one: "ERROR: Missing -Signed-off-by: line(s)". kmod does not used Signed-Off lines, so including -them is actually an error. In certain circumstances one can ignore the 80 -character per line limit. This is generally only allowed if the alternative -would make the code even less readable. +to clean up all the warnings and errors. In certain circumstances one can ignore +the 80 character per line limit. This is generally only allowed if the +alternative would make the code even less readable. Besides the kernel coding style above, kmod coding style is heavily based on oFono's and BlueZ's. Below some basic rules: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 527fed0b..ad4a690d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,11 @@ highly recommended. Commit messages, apart from stating why a particular change is made, can include a range of trailers. +### Signed-off-by + +By using a `Signed-off-by:` trailer you agree that you comply with the +[Developer Certificate of Origin](DCO.txt). + ### Issues, feature requests Whenever a patch resolves a particular issue, be that one on our [GitHub diff --git a/DCO.txt b/DCO.txt new file mode 100644 index 00000000..49b8cb05 --- /dev/null +++ b/DCO.txt @@ -0,0 +1,34 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved.