From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Dave Huseby" <dwh@linuxprogrammer.org>,
"Lars Schneider" <larsxschneider@gmail.com>,
"Đoàn Trần Công Danh" <congdanhqx@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send"
Date: Wed, 12 May 2021 10:45:00 +0200 [thread overview]
Message-ID: <patch-1.3-d18a3caa07-20210512T084137Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-0.3-0000000000-20210512T084137Z-avarab@gmail.com>
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 are being altered, only
moved around.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
---
Documentation/SubmittingPatches | 160 ++++++++++++++++----------------
1 file changed, 80 insertions(+), 80 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 55287d72e0..2643062624 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -167,6 +167,86 @@ or, on an older version of Git without support for --pretty=reference:
git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
....
+[[sign-off]]
+=== Certify your work by adding your `Signed-off-by` trailer
+
+To improve tracking of who did what, we ask you to certify that you
+wrote the patch or have the right to pass it on under the same license
+as ours, by "signing off" your patch. Without sign-off, we cannot
+accept your patches.
+
+If (and only if) you certify the below D-C-O:
+
+[[dco]]
+.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.
+____
+
+you add a "Signed-off-by" trailer to your commit, that looks like
+this:
+
+....
+ Signed-off-by: Random J Developer <random@developer.example.org>
+....
+
+This line can be added by Git if you run the git-commit command with
+the -s option.
+
+Notice that you can place your own `Signed-off-by` trailer when
+forwarding somebody else's patch with the above rules for
+D-C-O. Indeed you are encouraged to do so. Do not forget to
+place an in-body "From: " line at the beginning to properly attribute
+the change to its true author (see (2) above).
+
+This procedure originally came from the Linux kernel project, so our
+rule is quite similar to theirs, but what exactly it means to sign-off
+your patch differs from project to project, so it may be different
+from that of the project you are accustomed to.
+
+[[real-name]]
+Also notice that a real name is used in the `Signed-off-by` trailer. Please
+don't hide your real name.
+
+[[commit-trailers]]
+If you like, you can put extra tags at the end:
+
+. `Reported-by:` is used to credit someone who found the bug that
+ the patch attempts to fix.
+. `Acked-by:` says that the person who is more familiar with the area
+ the patch attempts to modify liked the patch.
+. `Reviewed-by:`, unlike the other tags, can only be offered by the
+ reviewer and means that she is completely satisfied that the patch
+ is ready for application. It is usually offered only after a
+ detailed review.
+. `Tested-by:` is used to indicate that the person applied the patch
+ and found it to have the desired effect.
+
+You can also create your own tag or use one that's in common usage
+such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
+
[[git-tools]]
=== Generate your patch using Git tools out of your commits.
@@ -302,86 +382,6 @@ Do not forget to add trailers such as `Acked-by:`, `Reviewed-by:` and
`Tested-by:` lines as necessary to credit people who helped your
patch, and "cc:" them when sending such a final version for inclusion.
-[[sign-off]]
-=== Certify your work by adding your `Signed-off-by` trailer
-
-To improve tracking of who did what, we ask you to certify that you
-wrote the patch or have the right to pass it on under the same license
-as ours, by "signing off" your patch. Without sign-off, we cannot
-accept your patches.
-
-If (and only if) you certify the below D-C-O:
-
-[[dco]]
-.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.
-____
-
-you add a "Signed-off-by" trailer to your commit, that looks like
-this:
-
-....
- Signed-off-by: Random J Developer <random@developer.example.org>
-....
-
-This line can be added by Git if you run the git-commit command with
-the -s option.
-
-Notice that you can place your own `Signed-off-by` trailer when
-forwarding somebody else's patch with the above rules for
-D-C-O. Indeed you are encouraged to do so. Do not forget to
-place an in-body "From: " line at the beginning to properly attribute
-the change to its true author (see (2) above).
-
-This procedure originally came from the Linux kernel project, so our
-rule is quite similar to theirs, but what exactly it means to sign-off
-your patch differs from project to project, so it may be different
-from that of the project you are accustomed to.
-
-[[real-name]]
-Also notice that a real name is used in the `Signed-off-by` trailer. Please
-don't hide your real name.
-
-[[commit-trailers]]
-If you like, you can put extra tags at the end:
-
-. `Reported-by:` is used to credit someone who found the bug that
- the patch attempts to fix.
-. `Acked-by:` says that the person who is more familiar with the area
- the patch attempts to modify liked the patch.
-. `Reviewed-by:`, unlike the other tags, can only be offered by the
- reviewer and means that she is completely satisfied that the patch
- is ready for application. It is usually offered only after a
- detailed review.
-. `Tested-by:` is used to indicate that the person applied the patch
- and found it to have the desired effect.
-
-You can also create your own tag or use one that's in common usage
-such as "Thanks-to:", "Based-on-patch-by:", or "Mentored-by:".
-
== Subsystems with dedicated maintainers
Some parts of the system have dedicated maintainers with their own
--
2.31.1.909.g789bb6d90e
next prev parent reply other threads:[~2021-05-12 8:45 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-12 8:44 [PATCH 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
2021-05-12 8:45 ` Ævar Arnfjörð Bjarmason [this message]
2021-05-12 9:29 ` [PATCH 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Felipe Contreras
2021-06-07 11:02 ` Ævar Arnfjörð Bjarmason
2021-06-07 16:16 ` Felipe Contreras
2021-05-12 8:45 ` [PATCH 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
2021-05-12 12:24 ` Đoàn Trần Công Danh
2021-05-12 22:40 ` Junio C Hamano
2021-05-12 8:45 ` [PATCH 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
2021-05-12 23:51 ` Dave Huseby
2021-05-13 6:38 ` Felipe Contreras
2021-05-13 14:45 ` Dave Huseby
2021-05-13 20:08 ` Felipe Contreras
2021-05-17 19:05 ` Dave Huseby
2021-05-13 7:50 ` Ævar Arnfjörð Bjarmason
2021-05-13 14:42 ` Dave Huseby
2021-06-07 11:03 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Ævar Arnfjörð Bjarmason
2021-06-07 11:03 ` [PATCH v2 1/3] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
2021-06-07 15:58 ` Đoàn Trần Công Danh
2021-06-07 11:03 ` [PATCH v2 2/3] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
2021-06-07 17:25 ` SZEDER Gábor
2021-06-07 11:03 ` [PATCH v2 3/3] SubmittingPatches: remove pine-specific hints from MUA hints Ævar Arnfjörð Bjarmason
2021-06-07 21:49 ` Johannes Schindelin
2021-06-08 3:50 ` [PATCH v2 0/3] SubmittingPatches: a few unrelated minor fixes Junio C Hamano
2021-07-22 12:11 ` [PATCH v3 0/2] SubmittingPatches: talk about GitHub CI, not Travis + move-only Ævar Arnfjörð Bjarmason
2021-07-22 12:11 ` [PATCH v3 1/2] SubmittingPatches: move discussion of Signed-off-by above "send" Ævar Arnfjörð Bjarmason
2021-07-23 6:36 ` Bagas Sanjaya
2021-07-22 12:11 ` [PATCH v3 2/2] SubmittingPatches: replace discussion of Travis with GitHub Actions Ævar Arnfjörð Bjarmason
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=patch-1.3-d18a3caa07-20210512T084137Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=congdanhqx@gmail.com \
--cc=dwh@linuxprogrammer.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=larsxschneider@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).