[edk2] [PATCH V2 2/2] Describe submission of a patch authored by someone else

Discussion:

Roy Franz

2015-06-30 04:12:27 UTC

Add a description of how to describe the authorship of a patch that
is submitted by someone other than the original author.
Add mention of git format-patch options for generating
more useful patch names in diffstat.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Roy Franz <***@linaro.org>
---
Contributions.txt | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/Contributions.txt b/Contributions.txt
index f87cbd7..6355654 100644
--- a/Contributions.txt
+++ b/Contributions.txt
@@ -67,7 +67,16 @@ Patch content inline or attached
* The first line of commit message is taken from the email's subject
line following [PATCH]. The remaining portion of the commit message
is the email's content until the '---' line.
-* git format-patch is one way to create this format
+* git format-patch is one way to create this format. In order to get
+ useful path names in the diffstat, the "--stat=1000 --stat-graph-width=20"
+ options should be used.
+* If a patch is being submitted by someone other than the orginal
+ author, then the orginal author's Signed-off-by/Contributed-under lines
+ should be first, followed by the Signed-off-by/Contributed-under lines
+ of the patch submitter. Any changes made by the submitter should be
+ noted above the submitter's Signed-off-by line. If git is being used
+ to prepare the patches, the git author of the commit corresponding to
+ the patch should be owned by the original author (git commit --author).

=== Definitions for sample patch email ===

--
2.1.4

Ard Biesheuvel

2015-07-01 08:20:25 UTC

Permalink

Replace the 38 identical Contributions.txt in subdirectories with a single
copy at the top level.
Contributed-under: TianoCore Contribution Agreement 1.0

I agree that the duplication seems wasteful, but how is this supposed
to work with the intended publication of subtrees as standalone (if
not read--only mirrored) Git repos ?

Roy Franz

2015-07-01 17:26:52 UTC

Permalink

On Wed, Jul 1, 2015 at 1:20 AM, Ard Biesheuvel

Post by Ard Biesheuvel

Replace the 38 identical Contributions.txt in subdirectories with a single
copy at the top level.
Contributed-under: TianoCore Contribution Agreement 1.0

I agree that the duplication seems wasteful, but how is this supposed
to work with the intended publication of subtrees as standalone (if
not read--only mirrored) Git repos ?

Is that actually the plan? I don't recall any positive feedback on breaking
up the project that way, and I think it will be a big mess if done that way.

I can change the removed files to have text that just references the top
level Contributions.txt file if that is desired.

Roy

Post by Ard Biesheuvel
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
edk2-devel mailing list
https://lists.sourceforge.net/lists/listinfo/edk2-devel

Ard Biesheuvel

2015-07-01 08:22:41 UTC

Permalink

Post by Roy Franz
Add a description of how to describe the authorship of a patch that
is submitted by someone other than the original author.
Add mention of git format-patch options for generating
more useful patch names in diffstat.
Contributed-under: TianoCore Contribution Agreement 1.0
---
Contributions.txt | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/Contributions.txt b/Contributions.txt
index f87cbd7..6355654 100644
--- a/Contributions.txt
+++ b/Contributions.txt
@@ -67,7 +67,16 @@ Patch content inline or attached
* The first line of commit message is taken from the email's subject
line following [PATCH]. The remaining portion of the commit message
is the email's content until the '---' line.
-* git format-patch is one way to create this format
+* git format-patch is one way to create this format. In order to get
+ useful path names in the diffstat, the "--stat=1000 --stat-graph-width=20"
+ options should be used.
+* If a patch is being submitted by someone other than the orginal
+ author, then the orginal author's Signed-off-by/Contributed-under lines
+ should be first, followed by the Signed-off-by/Contributed-under lines
+ of the patch submitter. Any changes made by the submitter should be
+ noted above the submitter's Signed-off-by line.

Should we adopt the square bracket notation as well? Or be more lax?

"""
Contrib-xxxx
S-o-b: xxx

bla bla bla
bla bla bla

Contrib-xxxx
S-o-b: xxx
"""

Actually, I lean towards the latter. The [] messages are often very
cryptic and terse.

Post by Roy Franz
If git is being used
+ to prepare the patches, the git author of the commit corresponding to
+ the patch should be owned by the original author (git commit --author).
=== Definitions for sample patch email ===
--
2.1.4
------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
edk2-devel mailing list
https://lists.sourceforge.net/lists/listinfo/edk2-devel

Roy Franz

2015-07-01 17:30:45 UTC

Permalink

On Wed, Jul 1, 2015 at 1:22 AM, Ard Biesheuvel

Post by Ard Biesheuvel

Should we adopt the square bracket notation as well? Or be more lax?
"""
Contrib-xxxx
S-o-b: xxx
bla bla bla
bla bla bla
Contrib-xxxx
S-o-b: xxx
"""
Actually, I lean towards the latter. The [] messages are often very
cryptic and terse.

Since I'm not familiar with the square bracket notation, I'll got with the
more lax :) I think we should keep things simple until that doesn't work
for us any more.

Roy

Post by Ard Biesheuvel

------------------------------------------------------------------------------
Don't Limit Your Business. Reach for the Cloud.
GigeNET's Cloud Solutions provide you with the tools and support that
you need to offload your IT needs and focus on growing your business.
Configured For All Businesses. Start Your Cloud Today.
https://www.gigenetcloud.com/
_______________________________________________
edk2-devel mailing list
https://lists.sourceforge.net/lists/listinfo/edk2-devel

Laszlo Ersek

2015-07-06 19:31:02 UTC

Permalink

Post by Ard Biesheuvel

Should we adopt the square bracket notation as well? Or be more lax?
"""
Contrib-xxxx
S-o-b: xxx
bla bla bla
bla bla bla
Contrib-xxxx
S-o-b: xxx
"""
Actually, I lean towards the latter.

It is more flexible indeed.

Thanks
Laszlo

Post by Ard Biesheuvel
The [] messages are often very
cryptic and terse.