SubmittingPatches: move discussion of Signed-off-by above "send"
Move the section discussing the addition of a SOB trailer above the section that discusses generating the patch itself. This makes sense as we don't want someone to go through the process of "git format-patch", only to realize late that they should have used "git commit -s" or equivalent. This is a move-only change, no lines here are being altered, only moved around. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Jul 22, 2021 at 14:11 UTC
4523dc8624cf3d494fcc3643a85b8dbb69858e07
1 file changed
+79
-79
Documentation/SubmittingPatches
+79
-79
@@ -167,6 +167,85 @@ or, on an older version of Git without support for --pretty=reference:
167
git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
168
....
169
170
+[[sign-off]]
171
+=== Certify your work by adding your `Signed-off-by` trailer
172
+
173
+To improve tracking of who did what, we ask you to certify that you
174
+wrote the patch or have the right to pass it on under the same license
175
+as ours, by "signing off" your patch. Without sign-off, we cannot
176
+accept your patches.
177
+
178
+If (and only if) you certify the below D-C-O:
179
+
180
+[[dco]]
181
+.Developer's Certificate of Origin 1.1
182
+____
183
+By making a contribution to this project, I certify that:
184
+
185
+a. The contribution was created in whole or in part by me and I
186
+ have the right to submit it under the open source license
187
+ indicated in the file; or
188
+
189
+b. The contribution is based upon previous work that, to the best
190
+ of my knowledge, is covered under an appropriate open source
191
+ license and I have the right under that license to submit that
192
+ work with modifications, whether created in whole or in part
193
+ by me, under the same open source license (unless I am
194
+ permitted to submit under a different license), as indicated
195
+ in the file; or
196
+
197
+c. The contribution was provided directly to me by some other
198
+ person who certified (a), (b) or (c) and I have not modified
199
+ it.
200
+
201
+d. I understand and agree that this project and the contribution
202
+ are public and that a record of the contribution (including all
203
+ personal information I submit with it, including my sign-off) is
204
+ maintained indefinitely and may be redistributed consistent with
205
+ this project or the open source license(s) involved.
206
+____
207
+
208
+you add a "Signed-off-by" trailer to your commit, that looks like
209
+this:
210
+
211
+....
212
+ Signed-off-by: Random J Developer <random@developer.example.org>
213
+....
214
+
215
+This line can be added by Git if you run the git-commit command with
216
+the -s option.
217
+
218
+Notice that you can place your own `Signed-off-by` trailer when
219
+forwarding somebody else's patch with the above rules for
220
+D-C-O. Indeed you are encouraged to do so. Do not forget to
221
+place an in-body "From: " line at the beginning to properly attribute
222
+the change to its true author (see (2) above).
223
+
224
+This procedure originally came from the Linux kernel project, so our
225
+rule is quite similar to theirs, but what exactly it means to sign-off
226
+your patch differs from project to project, so it may be different
227
+from that of the project you are accustomed to.
228
+
229
+[[real-name]]
230
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
231
+don't hide your real name.
232
+
233
+[[commit-trailers]]
234
+If you like, you can put extra tags at the end:
235
+
236
+. `Reported-by:` is used to credit someone who found the bug that
237
+ the patch attempts to fix.
238
+. `Acked-by:` says that the person who is more familiar with the area
239
+ the patch attempts to modify liked the patch.
240
+. `Reviewed-by:`, unlike the other tags, can only be offered by the
241
+ reviewers themselves when they are completely satisfied with the
242
+ patch after a detailed analysis.
243
+. `Tested-by:` is used to indicate that the person applied the patch
244
+ and found it to have the desired effect.
245
+
246
+You can also create your own tag or use one that's in common usage
247
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
248
+
249
[[git-tools]]
250
=== Generate your patch using Git tools out of your commits.
251
@@ -302,85 +381,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
381
`Tested-by:` lines as necessary to credit people who helped your
382
patch, and "cc:" them when sending such a final version for inclusion.
383
305
-[[sign-off]]
306
-=== Certify your work by adding your `Signed-off-by` trailer
307
-
308
-To improve tracking of who did what, we ask you to certify that you
309
-wrote the patch or have the right to pass it on under the same license
310
-as ours, by "signing off" your patch. Without sign-off, we cannot
311
-accept your patches.
312
-
313
-If (and only if) you certify the below D-C-O:
314
-
315
-[[dco]]
316
-.Developer's Certificate of Origin 1.1
317
-____
318
-By making a contribution to this project, I certify that:
319
-
320
-a. The contribution was created in whole or in part by me and I
321
- have the right to submit it under the open source license
322
- indicated in the file; or
323
-
324
-b. The contribution is based upon previous work that, to the best
325
- of my knowledge, is covered under an appropriate open source
326
- license and I have the right under that license to submit that
327
- work with modifications, whether created in whole or in part
328
- by me, under the same open source license (unless I am
329
- permitted to submit under a different license), as indicated
330
- in the file; or
331
-
332
-c. The contribution was provided directly to me by some other
333
- person who certified (a), (b) or (c) and I have not modified
334
- it.
335
-
336
-d. I understand and agree that this project and the contribution
337
- are public and that a record of the contribution (including all
338
- personal information I submit with it, including my sign-off) is
339
- maintained indefinitely and may be redistributed consistent with
340
- this project or the open source license(s) involved.
341
-____
342
-
343
-you add a "Signed-off-by" trailer to your commit, that looks like
344
-this:
345
-
346
-....
347
- Signed-off-by: Random J Developer <random@developer.example.org>
348
-....
349
-
350
-This line can be added by Git if you run the git-commit command with
351
-the -s option.
352
-
353
-Notice that you can place your own `Signed-off-by` trailer when
354
-forwarding somebody else's patch with the above rules for
355
-D-C-O. Indeed you are encouraged to do so. Do not forget to
356
-place an in-body "From: " line at the beginning to properly attribute
357
-the change to its true author (see (2) above).
358
-
359
-This procedure originally came from the Linux kernel project, so our
360
-rule is quite similar to theirs, but what exactly it means to sign-off
361
-your patch differs from project to project, so it may be different
362
-from that of the project you are accustomed to.
363
-
364
-[[real-name]]
365
-Also notice that a real name is used in the `Signed-off-by` trailer. Please
366
-don't hide your real name.
367
-
368
-[[commit-trailers]]
369
-If you like, you can put extra tags at the end:
370
-
371
-. `Reported-by:` is used to credit someone who found the bug that
372
- the patch attempts to fix.
373
-. `Acked-by:` says that the person who is more familiar with the area
374
- the patch attempts to modify liked the patch.
375
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
376
- reviewers themselves when they are completely satisfied with the
377
- patch after a detailed analysis.
378
-. `Tested-by:` is used to indicate that the person applied the patch
379
- and found it to have the desired effect.
380
-
381
-You can also create your own tag or use one that's in common usage
382
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
383
-
384
== Subsystems with dedicated maintainers
385
386
Some parts of the system have dedicated maintainers with their own