Patch procedure for dummies

Patch procedure for dummies

[AJ ONeal]

Please give me feedback and I'll post this on the wiki.

A task-oriented guide to creating a patch:



> Let's say you create a new recipe and you'd like to submit it for inclusion
> (and you've already tested that it works, of course).
>
> 1. Now commit with a good strong helpful message
>
>     git add recipes/nodejs/
>     git commit # don't use the -m option
>
> 2. The message should look like this
>
>     added recipe for node.js
>
>     * added recipe for node.js (bug #5555 - no nodejs recipe)
>     ** patched libev's wscript to not try to execute code
>     ** patched node's wscript to not search in '/usr/include'
>
>     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>
> 3. Create your patch
>
>     git format-patch -1 # or however many commits are part of this change
>
> 3++. If you are submitting a second version also add "--subject-prefix
> [v2]"
>
>     git send-email
>
> Your patch will be immediately visible on
> http://patchwork.openembedded.org/patch/
>


> 4. Once your patch has been accepted or rejected, create an account and
> update the status to "accepted" or "rejected"
>
> 4++. If you get soft-rejected (a lot of feedback), make the changes, submit
> the next version, and update the status of the previous patch to
> "superseded"
>
> Appendix: Properly configuring git (using tekkub@gmail.com as an example
> user)
>
>     sudo apt-get install git-core git-email
>     git config --global user.name "Tekkub"
>     git config --global user.email "tekkub@gmail.com"
>     git config --global sendemail.smtpserver smtp.gmail.com
>     git config --global sendemail.smtpserverport 587
>     git config --global sendemail.smtpencryption tls
>     git config --global sendemail.smtpuser tekkupl@gmail.com
>

Re: Patch procedure for dummies

[Paul Menzel]

[-- Attachment #1: Type: text/plain, Size: 2772 bytes --]

Am Mittwoch, den 25.08.2010, 08:43 -0600 schrieb AJ ONeal:
> Please give me feedback and I'll post this on the wiki.
> 
> A task-oriented guide to creating a patch:
> 
> > Let's say you create a new recipe and you'd like to submit it for inclusion
> > (and you've already tested that it works, of course).
> >
> > 1. Now commit with a good strong helpful message

… explaining your changes in a way others get a short overview without
looking at the code.

> >     git add recipes/nodejs/
> >     git commit # don't use the -m option
> >
> > 2. The message should look like this
> >
> >     added recipe for node.js

The rule is to give the recipe name at the beginning followed by a
colon.

> >     * added recipe for node.js (bug #5555 - no nodejs recipe)
> >     ** patched libev's wscript to not try to execute code
> >     ** patched node's wscript to not search in '/usr/include'
> >
> >     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
> >
> > 3. Create your patch
> >
> >     git format-patch -1 # or however many commits are part of this change

Signed-off-by line can be added automatically either using `-s` either
in 1. or 3.. I would recommend 3..

> > 3++. If you are submitting a second version also add "--subject-prefix
> > [v2]"

… to `git format-patch`.

> >     git send-email
> >
> > Your patch will be immediately visible on
> > http://patchwork.openembedded.org/patch/
> >
> 
> 
> > 4. Once your patch has been accepted or rejected, create an account and
> > update the status to "accepted" or "rejected"
> >
> > 4++. If you get soft-rejected (a lot of feedback), make the changes, submit
> > the next version,

… using `--subject-prefix` to mark the patch iteration.

> > and update the status of the previous patch to
> > "superseded"
> >
> > Appendix: Properly configuring git (using tekkub@gmail.com as an example
> > user)
> >
> >     sudo apt-get install git-core git-email

Please use `sudo aptitude install git-core git-email` since it is the
recommended package tool by Debian. People preferring `apt-get` know how
to use it instead.

> >     git config --global user.name "Tekkub"
> >     git config --global user.email "tekkub@gmail.com"

These two should be given in 0. or 1. as they are also important for the
commit meta data.

> >     git config --global sendemail.smtpserver smtp.gmail.com
> >     git config --global sendemail.smtpserverport 587
> >     git config --global sendemail.smtpencryption tls
> >     git config --global sendemail.smtpuser tekkupl@gmail.com

Thank you for your work. I would suggest to include links to more in
depth information (commit policy, patchwork) after each section for a
clarification.


Thanks,

Paul

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 205 bytes --]

Re: Patch procedure for dummies

[Frans Meulenbroeks]

2010/8/25 Paul Menzel <paulepanter@users.sourceforge.net>:
> Am Mittwoch, den 25.08.2010, 08:43 -0600 schrieb AJ ONeal:
>> Please give me feedback and I'll post this on the wiki.
>>
>> A task-oriented guide to creating a patch:
>>
>> > Let's say you create a new recipe and you'd like to submit it for inclusion
>> > (and you've already tested that it works, of course).
>> >
>> > 1. Now commit with a good strong helpful message
>
> … explaining your changes in a way others get a short overview without
> looking at the code.

See http://wiki.openembedded.net/index.php/Commit_Policy on what
should be in the commit message.
>
>> >     git add recipes/nodejs/
>> >     git commit # don't use the -m option
>> >
>> > 2. The message should look like this
>> >
>> >     added recipe for node.js
>
> The rule is to give the recipe name at the beginning followed by a
> colon.
>
>> >     * added recipe for node.js (bug #5555 - no nodejs recipe)
>> >     ** patched libev's wscript to not try to execute code
>> >     ** patched node's wscript to not search in '/usr/include'
>> >
>> >     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>> >
>> > 3. Create your patch
>> >
>> >     git format-patch -1 # or however many commits are part of this change
>
> Signed-off-by line can be added automatically either using `-s` either
> in 1. or 3.. I would recommend 3..
>
>> > 3++. If you are submitting a second version also add "--subject-prefix
>> > [v2]"
>
> … to `git format-patch`.
>
>> >     git send-email

with the names of the files generated by git format-patch as argument.
e.g. git format-patch 0001-this-is-an-example.patch
>> >
>> > Your patch will be immediately visible on
>> > http://patchwork.openembedded.org/patch/
>> >
>>
>>
>> > 4. Once your patch has been accepted or rejected, create an account and
>> > update the status to "accepted" or "rejected"
>> >
>> > 4++. If you get soft-rejected (a lot of feedback), make the changes, submit
>> > the next version,
>
> … using `--subject-prefix` to mark the patch iteration.
>
>> > and update the status of the previous patch to
>> > "superseded"
>> >
>> > Appendix: Properly configuring git (using tekkub@gmail.com as an example
>> > user)
>> >
>> >     sudo apt-get install git-core git-email
>
> Please use `sudo aptitude install git-core git-email` since it is the
> recommended package tool by Debian. People preferring `apt-get` know how
> to use it instead.

Note that this is specific for debian variants (including ubuntu).
Fedora and openSuse have different packet managers
>
>> >     git config --global user.name "Tekkub"
>> >     git config --global user.email "tekkub@gmail.com"
>
> These two should be given in 0. or 1. as they are also important for the
> commit meta data.

Agree (otherwise git commit -s is not going to work)
>
>> >     git config --global sendemail.smtpserver smtp.gmail.com
>> >     git config --global sendemail.smtpserverport 587
>> >     git config --global sendemail.smtpencryption tls
>> >     git config --global sendemail.smtpuser tekkupl@gmail.com
>
> Thank you for your work. I would suggest to include links to more in
> depth information (commit policy, patchwork) after each section for a
> clarification.
>
>
Fully agree.

Thanks for writing this.

Frans

Re: Patch procedure for dummies

[J. L.]

A huge thanks for taking the time AJ keep you the great work, I am
sure your helping tons of people me included!




On Wed, Aug 25, 2010 at 7:43 AM, AJ ONeal <coolaj86@gmail.com> wrote:
> Please give me feedback and I'll post this on the wiki.
>
> A task-oriented guide to creating a patch:
>
>
>
>> Let's say you create a new recipe and you'd like to submit it for inclusion
>> (and you've already tested that it works, of course).
>>
>> 1. Now commit with a good strong helpful message
>>
>>     git add recipes/nodejs/
>>     git commit # don't use the -m option
>>
>> 2. The message should look like this
>>
>>     added recipe for node.js
>>
>>     * added recipe for node.js (bug #5555 - no nodejs recipe)
>>     ** patched libev's wscript to not try to execute code
>>     ** patched node's wscript to not search in '/usr/include'
>>
>>     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>>
>> 3. Create your patch
>>
>>     git format-patch -1 # or however many commits are part of this change
>>
>> 3++. If you are submitting a second version also add "--subject-prefix
>> [v2]"
>>
>>     git send-email
>>
>> Your patch will be immediately visible on
>> http://patchwork.openembedded.org/patch/
>>
>
>
>> 4. Once your patch has been accepted or rejected, create an account and
>> update the status to "accepted" or "rejected"
>>
>> 4++. If you get soft-rejected (a lot of feedback), make the changes, submit
>> the next version, and update the status of the previous patch to
>> "superseded"
>>
>> Appendix: Properly configuring git (using tekkub@gmail.com as an example
>> user)
>>
>>     sudo apt-get install git-core git-email
>>     git config --global user.name "Tekkub"
>>     git config --global user.email "tekkub@gmail.com"
>>     git config --global sendemail.smtpserver smtp.gmail.com
>>     git config --global sendemail.smtpserverport 587
>>     git config --global sendemail.smtpencryption tls
>>     git config --global sendemail.smtpuser tekkupl@gmail.com
>>
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel
>

Re: Patch procedure for dummies

[Hauser, Wolfgang (external)]

Thanks from me too, but for me it would be helpful to add the necessary steps for people which don't have
snmp access for git and have to send patches through the allowed mail client as an attachment.

Regards
Wolfgang
 
-----Ursprüngliche Nachricht-----
Von: openembedded-devel-bounces@lists.openembedded.org [mailto:openembedded-devel-bounces@lists.openembedded.org] Im Auftrag von J. L. 
Gesendet: Mittwoch, 25. August 2010 19:47
An: openembedded-devel@lists.openembedded.org
Betreff: Re: [oe] Patch procedure for dummies

A huge thanks for taking the time AJ keep you the great work, I am
sure your helping tons of people me included!




On Wed, Aug 25, 2010 at 7:43 AM, AJ ONeal <coolaj86@gmail.com> wrote:
> Please give me feedback and I'll post this on the wiki.
>
> A task-oriented guide to creating a patch:
>
>
>
>> Let's say you create a new recipe and you'd like to submit it for inclusion
>> (and you've already tested that it works, of course).
>>
>> 1. Now commit with a good strong helpful message
>>
>>     git add recipes/nodejs/
>>     git commit # don't use the -m option
>>
>> 2. The message should look like this
>>
>>     added recipe for node.js
>>
>>     * added recipe for node.js (bug #5555 - no nodejs recipe)
>>     ** patched libev's wscript to not try to execute code
>>     ** patched node's wscript to not search in '/usr/include'
>>
>>     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>>
>> 3. Create your patch
>>
>>     git format-patch -1 # or however many commits are part of this change
>>
>> 3++. If you are submitting a second version also add "--subject-prefix
>> [v2]"
>>
>>     git send-email
>>
>> Your patch will be immediately visible on
>> http://patchwork.openembedded.org/patch/
>>
>
>
>> 4. Once your patch has been accepted or rejected, create an account and
>> update the status to "accepted" or "rejected"
>>
>> 4++. If you get soft-rejected (a lot of feedback), make the changes, submit
>> the next version, and update the status of the previous patch to
>> "superseded"
>>
>> Appendix: Properly configuring git (using tekkub@gmail.com as an example
>> user)
>>
>>     sudo apt-get install git-core git-email
>>     git config --global user.name "Tekkub"
>>     git config --global user.email "tekkub@gmail.com"
>>     git config --global sendemail.smtpserver smtp.gmail.com
>>     git config --global sendemail.smtpserverport 587
>>     git config --global sendemail.smtpencryption tls
>>     git config --global sendemail.smtpuser tekkupl@gmail.com
>>
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel
>

_______________________________________________
Openembedded-devel mailing list
Openembedded-devel@lists.openembedded.org
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel

Re: Patch procedure for dummies

[Hauser, Wolfgang (external)]

In an earlier mail, I was told that it doesn't matter for patchwork if a patch is sent as an attachment.

We are pinned on Outlook here and webmailers are filtered out by the proxy, so I need to send patches via Outlook.
Easiest way in Outlook is an attachment.

Regards 
Wolfgang Hauser

-----Ursprüngliche Nachricht-----
Von: openembedded-devel-bounces@lists.openembedded.org [mailto:openembedded-devel-bounces@lists.openembedded.org] Im Auftrag von Frans Meulenbroeks
Gesendet: Donnerstag, 26. August 2010 13:50
An: openembedded-devel@lists.openembedded.org
Betreff: Re: [oe] Patch procedure for dummies

2010/8/26 Hauser, Wolfgang (external) <Wolfgang.Hauser.external@eads.com>:
> Thanks from me too, but for me it would be helpful to add the necessary steps for people which don't have
> snmp access for git and have to send patches through the allowed mail client as an attachment.

Patches should not be set as attachment but inline.
If you do not have snmp access to your email account you have two options:
1. use a different account (e.g. gmail). you can make one especially
for this. Note that the account may differ from the one in signed-off
(although that is inconvenient)
2. just include the patch in the body of your email. Make sure you use
an email client that does not touch the message (turn spaces in tabs,
wrap lines etc etc).
In the past I did this. A good mail client to do so is pine (or alpine)

Frans

_______________________________________________
Openembedded-devel mailing list
Openembedded-devel@lists.openembedded.org
http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel

Re: Patch procedure for dummies

[Frans Meulenbroeks]

2010/8/26 Hauser, Wolfgang (external) <Wolfgang.Hauser.external@eads.com>:
> In an earlier mail, I was told that it doesn't matter for patchwork if a patch is sent as an attachment.
>
> We are pinned on Outlook here and webmailers are filtered out by the proxy, so I need to send patches via Outlook.
> Easiest way in Outlook is an attachment.
>

I'm not sure what patchwork does, but it could well be that the
mailing list itself filters attachements.
I don't think I have seen attachements on this list (but I may be mistaken).

Frans

Re: Patch procedure for dummies

[AJ ONeal]

I believe that I have compiled all of the notes from this thread into the
wiki:
http://wiki.openembedded.net/index.php/How_to_submit_a_patch_for_dummies

Please review and give feedback.

AJ ONeal


On Wed, Aug 25, 2010 at 8:43 AM, AJ ONeal <coolaj86@gmail.com> wrote:

> Please give me feedback and I'll post this on the wiki.
>
> A task-oriented guide to creating a patch:
>
>
>
>> Let's say you create a new recipe and you'd like to submit it for
>> inclusion (and you've already tested that it works, of course).
>>
>> 1. Now commit with a good strong helpful message
>>
>>     git add recipes/nodejs/
>>     git commit # don't use the -m option
>>
>> 2. The message should look like this
>>
>>     added recipe for node.js
>>
>>     * added recipe for node.js (bug #5555 - no nodejs recipe)
>>     ** patched libev's wscript to not try to execute code
>>     ** patched node's wscript to not search in '/usr/include'
>>
>>     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>>
>> 3. Create your patch
>>
>>     git format-patch -1 # or however many commits are part of this change
>>
>> 3++. If you are submitting a second version also add "--subject-prefix
>> [v2]"
>>
>>     git send-email
>>
>> Your patch will be immediately visible on
>> http://patchwork.openembedded.org/patch/
>>
>
>
>> 4. Once your patch has been accepted or rejected, create an account and
>> update the status to "accepted" or "rejected"
>>
>> 4++. If you get soft-rejected (a lot of feedback), make the changes,
>> submit the next version, and update the status of the previous patch to
>> "superseded"
>>
>> Appendix: Properly configuring git (using tekkub@gmail.com as an example
>> user)
>>
>>     sudo apt-get install git-core git-email
>>     git config --global user.name "Tekkub"
>>     git config --global user.email "tekkub@gmail.com"
>>     git config --global sendemail.smtpserver smtp.gmail.com
>>     git config --global sendemail.smtpserverport 587
>>     git config --global sendemail.smtpencryption tls
>>     git config --global sendemail.smtpuser tekkupl@gmail.com
>>
>
>

Re: Patch procedure for dummies

[Khem Raj]

On Wed, Sep 15, 2010 at 9:41 AM, AJ ONeal <coolaj86@gmail.com> wrote:
> I believe that I have compiled all of the notes from this thread into the
> wiki:
> http://wiki.openembedded.net/index.php/How_to_submit_a_patch_for_dummies
>
> Please review and give feedback.


looks good. I have done some corrections and additions on the page.

>
> AJ ONeal
>
>
> On Wed, Aug 25, 2010 at 8:43 AM, AJ ONeal <coolaj86@gmail.com> wrote:
>
>> Please give me feedback and I'll post this on the wiki.
>>
>> A task-oriented guide to creating a patch:
>>
>>
>>
>>> Let's say you create a new recipe and you'd like to submit it for
>>> inclusion (and you've already tested that it works, of course).
>>>
>>> 1. Now commit with a good strong helpful message
>>>
>>>     git add recipes/nodejs/
>>>     git commit # don't use the -m option
>>>
>>> 2. The message should look like this
>>>
>>>     added recipe for node.js
>>>
>>>     * added recipe for node.js (bug #5555 - no nodejs recipe)
>>>     ** patched libev's wscript to not try to execute code
>>>     ** patched node's wscript to not search in '/usr/include'
>>>
>>>     Signed-off-by: AJ ONeal <coolaj86@gmail.com>
>>>
>>> 3. Create your patch
>>>
>>>     git format-patch -1 # or however many commits are part of this change
>>>
>>> 3++. If you are submitting a second version also add "--subject-prefix
>>> [v2]"
>>>
>>>     git send-email
>>>
>>> Your patch will be immediately visible on
>>> http://patchwork.openembedded.org/patch/
>>>
>>
>>
>>> 4. Once your patch has been accepted or rejected, create an account and
>>> update the status to "accepted" or "rejected"
>>>
>>> 4++. If you get soft-rejected (a lot of feedback), make the changes,
>>> submit the next version, and update the status of the previous patch to
>>> "superseded"
>>>
>>> Appendix: Properly configuring git (using tekkub@gmail.com as an example
>>> user)
>>>
>>>     sudo apt-get install git-core git-email
>>>     git config --global user.name "Tekkub"
>>>     git config --global user.email "tekkub@gmail.com"
>>>     git config --global sendemail.smtpserver smtp.gmail.com
>>>     git config --global sendemail.smtpserverport 587
>>>     git config --global sendemail.smtpencryption tls
>>>     git config --global sendemail.smtpuser tekkupl@gmail.com
>>>
>>
>>
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel
>



-- 
-Khem