diff options
author | Chad Versace <chad@chad-versace.us> | 2014-07-27 15:25:40 -0700 |
---|---|---|
committer | Chad Versace <chad.versace@linux.intel.com> | 2014-09-06 15:50:12 -0700 |
commit | 0e8f7e87f9c9e68a1a158baa89ac2fb5bf29f13e (patch) | |
tree | 4d2b800a6b0afaa2c1a138078f3272e01778d753 | |
parent | 339a157253f8769992519d5ed9ab4b4860c2670b (diff) | |
download | waffle-0e8f7e87f9c9e68a1a158baa89ac2fb5bf29f13e.tar.gz |
HACKING: Improve section "Sign your work"
Simplify the discussion of Signed-off-by and Developer's Certificate of
Origin.
Pre-patch, HACKING.txt quoted the entirety of Section 12 of the kernel's
Documentation/SubmittingPatches. Linus's writing style, though, is
rambling and unfocused. This patch cleans it up.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
-rw-r--r-- | HACKING.txt | 124 |
1 files changed, 51 insertions, 73 deletions
diff --git a/HACKING.txt b/HACKING.txt index ca74bb8..08420e9 100644 --- a/HACKING.txt +++ b/HACKING.txt @@ -97,77 +97,55 @@ that new code be licensed under one of the following licenses: BSD, MIT, Apache Sign your work -------------- +Waffle follows the sign-off process of the Linux kernel. This gives a clear +chain of trust for every patch received. -A Signed-off-by tag is required for all patches. I defer to the kernel's -discussion of this topic. - -[Copied from the linux kernel, /Documentation/SubmittingPatches.] - -To improve tracking of who did what, especially with patches that can -percolate to their final resting place in the kernel through several -layers of maintainers, we've introduced a "sign-off" procedure on -patches that are being emailed around. - -The sign-off is a simple line at the end of the explanation for the -patch, which certifies that you wrote it or otherwise have the right to -pass it on as a open-source patch. The rules are pretty simple: if you -can certify the below: - - 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. - -then you just add a line saying - - Signed-off-by: Random J Developer <random@developer.example.org> - -using your real name (sorry, no pseudonyms or anonymous contributions.) - -Some people also put extra tags at the end. They'll just be ignored for -now, but you can do this to mark internal company procedures or just -point out some special detail about the sign-off. - -If you are a subsystem or branch maintainer, sometimes you need to slightly -modify patches you receive in order to merge them, because the code is not -exactly the same in your tree and the submitters'. If you stick strictly to -rule (c), you should ask the submitter to rediff, but this is a totally -counter-productive waste of time and energy. Rule (b) allows you to adjust -the code, but then it is very impolite to change one submitter's code and -make him endorse your bugs. To solve this problem, it is recommended that -you add a line between the last Signed-off-by header and yours, indicating -the nature of your changes. While there is nothing mandatory about this, it -seems like prepending the description with your mail and/or name, all -enclosed in square brackets, is noticeable enough to make it obvious that -you are responsible for last-minute changes. Example : - - Signed-off-by: Random J Developer <random@developer.example.org> - [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h] - Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org> - -This practise is particularly helpful if you maintain a stable branch and -want at the same time to credit the author, track changes, merge the fix, -and protect the submitter from complaints. Note that under no circumstances -can you change the author's identity (the From header), as it is the one -which appears in the changelog. +Each patch submitted to Waffle requires a 'Signed-off-by' tag in the commit +message. For example, below is a commit submitted by Emil: + + commit 3413e4f32ac63679d685b686eee48442459ec835 + Author: Emil Velikov <emil.l.velikov@gmail.com> + Date: Fri Jul 4 04:15:02 2014 +0100 + + third_party/getopt: include BSD licensed getopt implementation + + This module has been ripped out of the apitrace project + https://github.com/apitrace/apitrace + + Used by utils/wflinfo and examples/gl_basic. + + Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com> + +By placing your sign-off on a patch, you agree to the below certificate of +origin [DCO-1.1], as found in the Linux kernel v3.15. + + 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. + +References +---------- +[DCO-1.1] "Developer's Certificate of Origin 1.1". + (http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches?id=v3.15#n332) |