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

Message ID 1435637547-17270-2-git-send-email-roy.franz@linaro.org
State New
Headers show

Commit Message

Roy Franz June 30, 2015, 4:12 a.m.
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 <roy.franz@linaro.org>
---
 Contributions.txt | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

Comments

Ard Biesheuvel July 1, 2015, 8:22 a.m. | #1
On 30 June 2015 at 06:12, Roy Franz <roy.franz@linaro.org> wrote:
> 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 <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.

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.

> 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
> edk2-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/edk2-devel

------------------------------------------------------------------------------
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/
Roy Franz July 1, 2015, 5:30 p.m. | #2
On Wed, Jul 1, 2015 at 1:22 AM, Ard Biesheuvel
<ard.biesheuvel@linaro.org> wrote:
> On 30 June 2015 at 06:12, Roy Franz <roy.franz@linaro.org> wrote:
>> 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 <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.
>
> 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

>
>> 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
>> edk2-devel@lists.sourceforge.net
>> https://lists.sourceforge.net/lists/listinfo/edk2-devel
>
> ------------------------------------------------------------------------------
> 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
> edk2-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/edk2-devel

------------------------------------------------------------------------------
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/

Patch hide | download patch | download mbox

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 ===