@matheusbsbs / matheus-bagliano / commits / eafd5d9483

doc: clarify distinction between sign-off and pgp-signing

The documentation for submission discourages pgp-signing, but demands a proper sign-off by contributors. However, when skimming the headings, the wording of the section for sign-off could mistakenly be understood as concerning pgp-signing. Thus, new contributors could oversee the necessary sign-off. This commit improves the wording such that the section about sign-off cannot be misunderstood as pgp-signing. In addition, the paragraph about pgp-signing is changed such that it avoids the impression that pgp-signing could be relevant at later stages of the submission. Signed-off-by: Cornelius Weig <cornelius.weig@tngtech.com> Helped-by: Philip Oakley <philipoakley@iee.org> Helped-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Cornelius Weig committed Jan 27, 2017 at 21:01 UTC eafd5d9483ed2298a2bcebf20a7aeb50e948ba10
1 file changed +6 -7
Documentation/SubmittingPatches
+6 -7
@@ -216,12 +216,11 @@ that it will be postponed.
216 Exception: If your mailer is mangling patches then someone may ask
217 you to re-send them using MIME, that is OK.
218
219 -Do not PGP sign your patch, at least for now. Most likely, your
220 -maintainer or other people on the list would not have your PGP
221 -key and would not bother obtaining it anyway. Your patch is not
222 -judged by who you are; a good patch from an unknown origin has a
223 -far better chance of being accepted than a patch from a known,
224 -respected origin that is done poorly or does incorrect things.
219 +Do not PGP sign your patch. Most likely, your maintainer or other people on the
220 +list would not have your PGP key and would not bother obtaining it anyway.
221 +Your patch is not judged by who you are; a good patch from an unknown origin
222 +has a far better chance of being accepted than a patch from a known, respected
223 +origin that is done poorly or does incorrect things.
224
225 If you really really really really want to do a PGP signed
226 patch, format it as "multipart/signed", not a text/plain message
@@ -246,7 +245,7 @@ patch.
245 *2* The mailing list: git@vger.kernel.org
246
247
249 -(5) Sign your work
248 +(5) Certify your work by adding your "Signed-off-by: " line
249
250 To improve tracking of who did what, we've borrowed the
251 "sign-off" procedure from the Linux kernel project on patches