blob: 2b000f665ae4fccadb83b93fb4a9833ae3aff0c7 [file] [log] [blame]
Marian Harbachebeb1542019-12-13 10:42:46 +01001:linkattrs:
Fredrik Luthander700f6de2014-03-17 01:07:58 +01002= Gerrit Code Review - Signed-off-by Lines
Shawn O. Pearce7c85da42009-06-24 19:13:32 -07003
4[NOTE]
Marian Harbach34253372019-12-10 18:01:31 +01005This 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. Pearce7c85da42009-06-24 19:13:32 -07006and is covered by the GPLv2.
7
8[[Signed-off-by]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -08009== Signed-off-by:
Shawn O. Pearce7c85da42009-06-24 19:13:32 -070010
11To improve tracking of who did what, especially with patches that can
12percolate to their final resting place in the kernel through several
13layers of maintainers, we've introduced a "sign-off" procedure on
14patches that are being emailed around.
15
16The sign-off is a simple line at the end of the explanation for the
17patch, which certifies that you wrote it or otherwise have the right to
18pass it on as a open-source patch. The rules are pretty simple: if you
19can 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
49then you just add a line saying
50
51----
52 Signed-off-by: Random J Developer <random@developer.example.org>
53----
54
55using your real name (sorry, no pseudonyms or anonymous contributions.)
56
57Some people also put extra tags at the end. They'll just be ignored for
58now, but you can do this to mark internal company procedures or just
Shawn O. Pearced6078462009-11-02 10:37:01 -080059point out some special detail about the sign-off.
Shawn O. Pearce7c85da42009-06-24 19:13:32 -070060
61If you are a subsystem or branch maintainer, sometimes you need to slightly
62modify patches you receive in order to merge them, because the code is not
63exactly the same in your tree and the submitters'. If you stick strictly to
64rule (c), you should ask the submitter to rediff, but this is a totally
65counter-productive waste of time and energy. Rule (b) allows you to adjust
66the code, but then it is very impolite to change one submitter's code and
67make him endorse your bugs. To solve this problem, it is recommended that
68you add a line between the last Signed-off-by header and yours, indicating
69the nature of your changes. While there is nothing mandatory about this, it
70seems like prepending the description with your mail and/or name, all
71enclosed in square brackets, is noticeable enough to make it obvious that
72you 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 Bakera752b322013-11-27 19:19:31 -070080This practice is particularly helpful if you maintain a stable branch and
Shawn O. Pearce7c85da42009-06-24 19:13:32 -070081want at the same time to credit the author, track changes, merge the fix,
82and protect the submitter from complaints. Note that under no circumstances
83can you change the author's identity (the From header), as it is the one
84which appears in the changelog.
85
86[[Acked-by]]
87[[Cc]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -080088== Acked-by:, Cc:
Shawn O. Pearce7c85da42009-06-24 19:13:32 -070089
90The Signed-off-by: tag indicates that the signer was involved in the
91development of the patch, or that he/she was in the patch's delivery path.
92
93If a person was not directly involved in the preparation or handling of a
94patch but wishes to signify and record their approval of it then they can
95arrange to have an Acked-by: line added to the patch's changelog.
96
97Acked-by: is often used by the maintainer of the affected code when that
98maintainer neither contributed to nor forwarded the patch.
99
100Acked-by: is not as formal as Signed-off-by:. It is a record that the acker
101has at least reviewed the patch and has indicated acceptance. Hence patch
102mergers will sometimes manually convert an acker's "yep, looks good to me"
103into an Acked-by:.
104
David Pursehouse92463562013-06-24 10:16:28 +0900105Acked-by: does not necessarily indicate acknowledgment of the entire patch.
Shawn O. Pearce7c85da42009-06-24 19:13:32 -0700106For example, if a patch affects multiple subsystems and has an Acked-by: from
David Pursehouse92463562013-06-24 10:16:28 +0900107one subsystem maintainer then this usually indicates acknowledgment of just
108the part which affects that maintainer's code. Judgment should be used here.
Shawn O. Pearce7c85da42009-06-24 19:13:32 -0700109When in doubt people should refer to the original discussion in the mailing
110list archives.
111
112If a person has had the opportunity to comment on a patch, but has not
113provided such comments, you may optionally add a "Cc:" tag to the patch.
114This is the only tag which might be added without an explicit action by the
115person it names. This tag documents that potentially interested parties
116have been included in the discussion
117
118
119[[Reported-by]]
120[[Tested-by]]
121[[Reviewed-by]]
Yuxuan 'fishy' Wang61698b12013-12-20 12:55:51 -0800122== Reported-by:, Tested-by: and Reviewed-by:
Shawn O. Pearce7c85da42009-06-24 19:13:32 -0700123
124If this patch fixes a problem reported by somebody else, consider adding a
125Reported-by: tag to credit the reporter for their contribution. Please
126note that this tag should not be added without the reporter's permission,
127especially if the problem was not reported in a public forum. That said,
128if we diligently credit our bug reporters, they will, hopefully, be
129inspired to help us again in the future.
130
131A Tested-by: tag indicates that the patch has been successfully tested (in
132some environment) by the person named. This tag informs maintainers that
133some testing has been performed, provides a means to locate testers for
134future patches, and ensures credit for the testers.
135
136Reviewed-by:, instead, indicates that the patch has been reviewed and found
137acceptable 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
163A Reviewed-by tag is a statement of opinion that the patch is an
164appropriate modification of the kernel without any remaining serious
165technical issues. Any interested reviewer (who has done the work) can
166offer a Reviewed-by tag for a patch. This tag serves to give credit to
167reviewers and to inform maintainers of the degree of review which has been
168done on the patch. Reviewed-by: tags, when supplied by reviewers known to
169understand the subject area and to perform thorough reviews, will normally
170increase the likelihood of your patch getting into the kernel.
171
Yuxuan 'fishy' Wangc955b4c2014-03-25 12:34:20 -0700172GERRIT
173------
Shawn O. Pearce7c85da42009-06-24 19:13:32 -0700174Part of link:index.html[Gerrit Code Review]
Yuxuan 'fishy' Wang99cb68d2013-10-31 17:26:00 -0700175
176SEARCHBOX
177---------