Marian Harbach | ebeb154 | 2019-12-13 10:42:46 +0100 | [diff] [blame] | 1 | :linkattrs: |
Fredrik Luthander | 700f6de | 2014-03-17 01:07:58 +0100 | [diff] [blame] | 2 | = Gerrit Code Review - Signed-off-by Lines |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 3 | |
| 4 | [NOTE] |
Marian Harbach | 3425337 | 2019-12-10 18:01:31 +0100 | [diff] [blame] | 5 | This document was literally taken from link:http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches;hb=4e8a2372f9255a1464ef488ed925455f53fbdaa1[linux-2.6 Documentation/SubmittingPatches,role=external,window=_blank] |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 6 | and is covered by the GPLv2. |
| 7 | |
| 8 | [[Signed-off-by]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 9 | == Signed-off-by: |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 10 | |
| 11 | To improve tracking of who did what, especially with patches that can |
| 12 | percolate to their final resting place in the kernel through several |
| 13 | layers of maintainers, we've introduced a "sign-off" procedure on |
| 14 | patches that are being emailed around. |
| 15 | |
| 16 | The sign-off is a simple line at the end of the explanation for the |
| 17 | patch, which certifies that you wrote it or otherwise have the right to |
| 18 | pass it on as a open-source patch. The rules are pretty simple: if you |
| 19 | can certify the below: |
| 20 | |
| 21 | ---- |
| 22 | Developer's Certificate of Origin 1.1 |
| 23 | |
| 24 | By making a contribution to this project, I certify that: |
| 25 | |
| 26 | (a) The contribution was created in whole or in part by me and I |
| 27 | have the right to submit it under the open source license |
| 28 | indicated in the file; or |
| 29 | |
| 30 | (b) The contribution is based upon previous work that, to the best |
| 31 | of my knowledge, is covered under an appropriate open source |
| 32 | license and I have the right under that license to submit that |
| 33 | work with modifications, whether created in whole or in part |
| 34 | by me, under the same open source license (unless I am |
| 35 | permitted to submit under a different license), as indicated |
| 36 | in the file; or |
| 37 | |
| 38 | (c) The contribution was provided directly to me by some other |
| 39 | person who certified (a), (b) or (c) and I have not modified |
| 40 | it. |
| 41 | |
| 42 | (d) I understand and agree that this project and the contribution |
| 43 | are public and that a record of the contribution (including all |
| 44 | personal information I submit with it, including my sign-off) is |
| 45 | maintained indefinitely and may be redistributed consistent with |
| 46 | this project or the open source license(s) involved. |
| 47 | ---- |
| 48 | |
| 49 | then you just add a line saying |
| 50 | |
| 51 | ---- |
| 52 | Signed-off-by: Random J Developer <random@developer.example.org> |
| 53 | ---- |
| 54 | |
| 55 | using your real name (sorry, no pseudonyms or anonymous contributions.) |
| 56 | |
| 57 | Some people also put extra tags at the end. They'll just be ignored for |
| 58 | now, but you can do this to mark internal company procedures or just |
Shawn O. Pearce | d607846 | 2009-11-02 10:37:01 -0800 | [diff] [blame] | 59 | point out some special detail about the sign-off. |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 60 | |
| 61 | If you are a subsystem or branch maintainer, sometimes you need to slightly |
| 62 | modify patches you receive in order to merge them, because the code is not |
| 63 | exactly the same in your tree and the submitters'. If you stick strictly to |
| 64 | rule (c), you should ask the submitter to rediff, but this is a totally |
| 65 | counter-productive waste of time and energy. Rule (b) allows you to adjust |
| 66 | the code, but then it is very impolite to change one submitter's code and |
| 67 | make him endorse your bugs. To solve this problem, it is recommended that |
| 68 | you add a line between the last Signed-off-by header and yours, indicating |
| 69 | the nature of your changes. While there is nothing mandatory about this, it |
| 70 | seems like prepending the description with your mail and/or name, all |
| 71 | enclosed in square brackets, is noticeable enough to make it obvious that |
| 72 | you are responsible for last-minute changes. Example : |
| 73 | |
| 74 | ---- |
| 75 | Signed-off-by: Random J Developer <random@developer.example.org> |
| 76 | [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h] |
| 77 | Signed-off-by: Lucky K Maintainer <lucky@maintainer.example.org> |
| 78 | ---- |
| 79 | |
Matt Baker | a752b32 | 2013-11-27 19:19:31 -0700 | [diff] [blame] | 80 | This practice is particularly helpful if you maintain a stable branch and |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 81 | want at the same time to credit the author, track changes, merge the fix, |
| 82 | and protect the submitter from complaints. Note that under no circumstances |
| 83 | can you change the author's identity (the From header), as it is the one |
| 84 | which appears in the changelog. |
| 85 | |
| 86 | [[Acked-by]] |
| 87 | [[Cc]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 88 | == Acked-by:, Cc: |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 89 | |
| 90 | The Signed-off-by: tag indicates that the signer was involved in the |
| 91 | development of the patch, or that he/she was in the patch's delivery path. |
| 92 | |
| 93 | If a person was not directly involved in the preparation or handling of a |
| 94 | patch but wishes to signify and record their approval of it then they can |
| 95 | arrange to have an Acked-by: line added to the patch's changelog. |
| 96 | |
| 97 | Acked-by: is often used by the maintainer of the affected code when that |
| 98 | maintainer neither contributed to nor forwarded the patch. |
| 99 | |
| 100 | Acked-by: is not as formal as Signed-off-by:. It is a record that the acker |
| 101 | has at least reviewed the patch and has indicated acceptance. Hence patch |
| 102 | mergers will sometimes manually convert an acker's "yep, looks good to me" |
| 103 | into an Acked-by:. |
| 104 | |
David Pursehouse | 9246356 | 2013-06-24 10:16:28 +0900 | [diff] [blame] | 105 | Acked-by: does not necessarily indicate acknowledgment of the entire patch. |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 106 | For example, if a patch affects multiple subsystems and has an Acked-by: from |
David Pursehouse | 9246356 | 2013-06-24 10:16:28 +0900 | [diff] [blame] | 107 | one subsystem maintainer then this usually indicates acknowledgment of just |
| 108 | the part which affects that maintainer's code. Judgment should be used here. |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 109 | When in doubt people should refer to the original discussion in the mailing |
| 110 | list archives. |
| 111 | |
| 112 | If a person has had the opportunity to comment on a patch, but has not |
| 113 | provided such comments, you may optionally add a "Cc:" tag to the patch. |
| 114 | This is the only tag which might be added without an explicit action by the |
| 115 | person it names. This tag documents that potentially interested parties |
| 116 | have been included in the discussion |
| 117 | |
| 118 | |
| 119 | [[Reported-by]] |
| 120 | [[Tested-by]] |
| 121 | [[Reviewed-by]] |
Yuxuan 'fishy' Wang | 61698b1 | 2013-12-20 12:55:51 -0800 | [diff] [blame] | 122 | == Reported-by:, Tested-by: and Reviewed-by: |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 123 | |
| 124 | If this patch fixes a problem reported by somebody else, consider adding a |
| 125 | Reported-by: tag to credit the reporter for their contribution. Please |
| 126 | note that this tag should not be added without the reporter's permission, |
| 127 | especially if the problem was not reported in a public forum. That said, |
| 128 | if we diligently credit our bug reporters, they will, hopefully, be |
| 129 | inspired to help us again in the future. |
| 130 | |
| 131 | A Tested-by: tag indicates that the patch has been successfully tested (in |
| 132 | some environment) by the person named. This tag informs maintainers that |
| 133 | some testing has been performed, provides a means to locate testers for |
| 134 | future patches, and ensures credit for the testers. |
| 135 | |
| 136 | Reviewed-by:, instead, indicates that the patch has been reviewed and found |
| 137 | acceptable according to the Reviewer's Statement: |
| 138 | |
| 139 | ---- |
| 140 | Reviewer's statement of oversight |
| 141 | |
| 142 | By offering my Reviewed-by: tag, I state that: |
| 143 | |
| 144 | (a) I have carried out a technical review of this patch to |
| 145 | evaluate its appropriateness and readiness for inclusion into |
| 146 | the mainline kernel. |
| 147 | |
| 148 | (b) Any problems, concerns, or questions relating to the patch |
| 149 | have been communicated back to the submitter. I am satisfied |
| 150 | with the submitter's response to my comments. |
| 151 | |
| 152 | (c) While there may be things that could be improved with this |
| 153 | submission, I believe that it is, at this time, (1) a |
| 154 | worthwhile modification to the kernel, and (2) free of known |
| 155 | issues which would argue against its inclusion. |
| 156 | |
| 157 | (d) While I have reviewed the patch and believe it to be sound, I |
| 158 | do not (unless explicitly stated elsewhere) make any |
| 159 | warranties or guarantees that it will achieve its stated |
| 160 | purpose or function properly in any given situation. |
| 161 | ---- |
| 162 | |
| 163 | A Reviewed-by tag is a statement of opinion that the patch is an |
| 164 | appropriate modification of the kernel without any remaining serious |
| 165 | technical issues. Any interested reviewer (who has done the work) can |
| 166 | offer a Reviewed-by tag for a patch. This tag serves to give credit to |
| 167 | reviewers and to inform maintainers of the degree of review which has been |
| 168 | done on the patch. Reviewed-by: tags, when supplied by reviewers known to |
| 169 | understand the subject area and to perform thorough reviews, will normally |
| 170 | increase the likelihood of your patch getting into the kernel. |
| 171 | |
Yuxuan 'fishy' Wang | c955b4c | 2014-03-25 12:34:20 -0700 | [diff] [blame] | 172 | GERRIT |
| 173 | ------ |
Shawn O. Pearce | 7c85da4 | 2009-06-24 19:13:32 -0700 | [diff] [blame] | 174 | Part of link:index.html[Gerrit Code Review] |
Yuxuan 'fishy' Wang | 99cb68d | 2013-10-31 17:26:00 -0700 | [diff] [blame] | 175 | |
| 176 | SEARCHBOX |
| 177 | --------- |