Please note that User Registration has been temporarily disabled due to a recent increase in automated registrations. If anyone needs an account, please request one here: RequestAccount. Thanks for your patience!

Difference between revisions of "How to submit a patch to OpenEmbedded"

From Openembedded.org
Jump to: navigation, search
(Create and Commit your patch)
(tweak patch -> commit)
 
(24 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== A task-oriented guide to creating a patch ==
+
OpenEmbedded welcomes contributions. Before submitting a patch however there are a few things to keep in mind.
  
'''Note''': More details are available on the policy pages, but this document is good enough for most beginners.
+
== Finding the right place for your patch ==
  
* [[Patchwork]]
+
OpenEmbedded is now split up into separate layers: OpenEmbedded-Core (OE-Core) which is a small set of core recipes, and other layers for recipes beyond that. For most layers, patches are sent to a mailing list for review before being merged. Further information specific to the layer you're working on please see the README file in the layer.
* [[Commit Policy]]
+
 
 +
New recipes in particular should be added to the appropriate layer. See the [http://layers.openembedded.org layer index] for the list of public layers. If your new recipe doesn't seem to fit anywhere it can be added to the meta-oe layer in the meta-openembedded repository, although if it is likely to be followed by numbers of similar recipes then you may wish to consider creating a new layer.
 +
 
 +
== A task-oriented guide to creating a patch ==
  
Let's say you [[How to create a bitbake recipe for dummies|create a new bitbake recipe for OpenEmbedded]] and you'd like to submit it for inclusion (and you've already tested that it works, of course).
+
Let's say you have made a fix to a recipe, you've tested that it works and you'd like to submit it for merging.
  
 
=== Set up git ===
 
=== Set up git ===
Line 12: Line 15:
 
Properly configuring git (using tekkub@gmail.com as an example user)
 
Properly configuring git (using tekkub@gmail.com as an example user)
  
On Debain / Ubuntu (Note: Fedora and OpenSuse use `yum`)
+
On Debian / Ubuntu (Note: Fedora uses `yum` OpenSuse uses zypper or yast)
  
 
  sudo aptitude install git-core git-email
 
  sudo aptitude install git-core git-email
Line 28: Line 31:
 
  git config --global sendemail.smtpuser tekkupl@gmail.com
 
  git config --global sendemail.smtpuser tekkupl@gmail.com
  
=== Create and Commit your patch ===
+
You can use the --envelope-sender option to have the email appear from the address you are subscribed to the list with. You will need to use the Accounts and import tab under the gmail settings tab. Use the Send mail as selection to address you want to send email from.
  
1. Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without
+
=== Subscribe to the mailing list ===
looking at the code.
+
  
cd org.openembedded.dev/ # or whereever you keep your clone of the repo
+
You need to subscribe to the appropriate mailing-list in order to be able to send your patch(es) there; for patches against OE-Core the mailing list is '''openembedded-core@lists.openembedded.org''' and for patches against meta-oe and many other layers the list is '''openembedded-devel@lists.openembedded.org'''. See [[Mailing lists]] for subscription and further details.
git add recipes/nodejs/
+
git commit # don't use the -m option
+
  
nodejs: added recipe for v0.2.1
+
=== Committing your patch ===
+
* included libev-cross patch which prevents wscript from executing cross-compiled code
+
* included node-cross patch which forwards DEST_CPU to v8's ARCH
+
  
2. Create your patch. '''Use -N for N commits''' to be included in the patch. '''Use -s to add a signoff line''' like "Signed-off-by: Tekku B. <tekkub@gmail.com>"
+
Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without looking at the code.  
  
  git format-patch -1 -s # creating a patch for my only commit and including my signature
+
cd oe-core/ # or whereever you keep your clone of the repo
 +
  git add meta/recipes-devtools/flex
 +
git commit -s # don't use the -m option but include my signature
  
If you are submitting a second version also add "--subject-prefix [v2]"
+
    flex: backport Debian patches to fix generated code warnings
 +
   
 +
    The generated parser had warnings regarding signess and return check
 +
    which makes Linux Kernel's perf tool from 3.4 release to fail without
 +
    those patches.
  
3. Send your patch to patchwork
+
All commit messages must include Signed-off-by (-s option to commit as above). For more guidelines on messages please see [[Commit Patch Message Guidelines]].
  
git send-email --to=openembedded-devel@lists.openembedded.org 001-nodejs-added-recipe-for-v0.2.1
+
Note that when adding multiple new recipes, each recipe should be added in a separate commit. For upgrades of existing recipes, the previous version should usually be deleted as part of the same commit to add the upgraded version.
  
Your patch will be immediately visible on http://patchwork.openembedded.org/patch/
+
=== Sending patches ===
+
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)''', you should make changes according to the feedback, submit the next version, and update the status of the previous patch to "superseded". Remember to use `--subject-prefix` to mark the patch iteration.
+
There are two possible methods for submitting patches. Either one is acceptable; for a series containing a number of patches the pull request method is preferred although not mandatory.
 +
 
 +
==== Sending using git-send-email ====
 +
 
 +
To send just the top commit on your current branch (substitute mailing list address as appropriate):
 +
 
 +
git send-email --to=openembedded-core@lists.openembedded.org --confirm=always -M -1
 +
 
 +
For multiple commits you can substitute -1 above with -N (where N is the number of commits) or instead specify a revision before which to start e.g. HEAD~3, master etc.
 +
 
 +
Note: in either case if you are submitting a patch for meta-oe or any layer other than OE-Core, please add the appopriate prefix so that it is clear which layer the patch is intended to be applied to:
 +
--subject-prefix="meta-oe][PATCH"
 +
 
 +
Please substitute "PATCH" with "PATCH v2" if you are submitting a revised version after addressing feedback (or v3, v4 etc.) 
 +
 
 +
==== Sending via a pull request ====
 +
 
 +
Alternatively, for larger patch series it is preferable to send a pull request which not only includes the patch but also a pointer to a branch that can be pulled from. This involves making a local branch for your changes, pushing this branch to an accessible repository and then using the <code>create-pull-request</code> and <code>send-pull-request</code> scripts (supplied with OE-Core) to create and send a patch series with a link to the branch for review. Step-by-step instructions:
 +
 
 +
# Find a repository to push your changes to, and add this as a remote to your git working tree. If you're going to be submitting a lot of changes, some of the repositories have a corresponding <code>-contrib</code> repository which you can use for this purpose - access to these for OE-related work is open to anyone who requests it. Otherwise github or some other public git hosting service can suffice.
 +
# Create a branch for your changes if you haven't already. Other than backports from master or fixing bugs that only occur in an older branch, this should be on top of the master branch.
 +
# Push the branch to the remote.
 +
# Run <code>scripts/create-pull-request -u remote-name</code> (where <code>remote-name</code> is the name of the remote where you'll be pushing the branch). For meta-oe and other layers where a single mailing list covers more than one layer you'll need to add <code>-p "layername][PATCH"</code> replacing layername with the name of the layer so that it is clear which layer the patches are intended for.
 +
# The script will report that it has created a <code>pull-XXXXX</code> directory has been created. Edit the <code>pull-XXXXX/0000-cover-letter.patch</code> with your favourite text editor and change the title and top of the body as appropriate.
 +
# Run <code>scripts/send-pull-request -p pull-XXXXX -t openembedded-core@lists.openembedded.org</code> (replacing openembedded-core@lists.openembedded.org with the appropriate mailing list address for layers other than OE-Core). Where there is a clear maintainer for the area you're changing it may also help to add <code>-C maintainer@example.com</code>.
 +
 
 +
== Community review ==
 +
 
 +
Your patch will be sent to the mailing list and for some layers should be immediately visible on http://patches.openembedded.org/
 +
 
 +
If you get feedback in reply to your patch, you should make changes according to the feedback and submit the next version. Please remember to use <code>--subject-prefix="PATCH v2"</code>, v3, v4 etc. to mark the patch iteration.
 +
 
 +
If your patch has not had any feedback after a few days it may have been missed or the appropriate reviewers may not currently be around; it is perfectly fine to reply to it yourself with a "ping" / reminder request for feedback.
  
 
== Appendix ==
 
== Appendix ==
  
=== steps for people which don't have snmp access for git ===  
+
=== Steps for people which don't have SMTP access for git ===  
  
Patches should not be set as attachment but inline.
+
Patches should not be sent as attachment but inline.
  
If you do not have snmp access to your email account you have two options:
+
If you do not have SMTP access to your email account you have two options:
  
1. use a different account (e.g. gmail). you can make one especially
+
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)
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
+
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,
an email client that does not touch the message (turn spaces in tabs,
+
 
wrap lines etc etc).
 
wrap lines etc etc).
  
A good mail client to do so is '''pine''' (or '''alpine''')
+
A good mail client to do so is '''pine''' (or '''alpine''') or '''mutt'''. For more information refer to [http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/email-clients.txt  Documentation/email-clients.txt] in linux
 +
kernel sources.
 +
 
 +
[[Category:FAQ]]
 +
[[Category:User]]

Latest revision as of 14:41, 30 August 2013

OpenEmbedded welcomes contributions. Before submitting a patch however there are a few things to keep in mind.

Contents

[edit] Finding the right place for your patch

OpenEmbedded is now split up into separate layers: OpenEmbedded-Core (OE-Core) which is a small set of core recipes, and other layers for recipes beyond that. For most layers, patches are sent to a mailing list for review before being merged. Further information specific to the layer you're working on please see the README file in the layer.

New recipes in particular should be added to the appropriate layer. See the layer index for the list of public layers. If your new recipe doesn't seem to fit anywhere it can be added to the meta-oe layer in the meta-openembedded repository, although if it is likely to be followed by numbers of similar recipes then you may wish to consider creating a new layer.

[edit] A task-oriented guide to creating a patch

Let's say you have made a fix to a recipe, you've tested that it works and you'd like to submit it for merging.

[edit] Set up git

Properly configuring git (using tekkub@gmail.com as an example user)

On Debian / Ubuntu (Note: Fedora uses `yum` OpenSuse uses zypper or yast)

sudo aptitude install git-core git-email

These are important to the commit meta-data

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

Any Google Apps account

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

You can use the --envelope-sender option to have the email appear from the address you are subscribed to the list with. You will need to use the Accounts and import tab under the gmail settings tab. Use the Send mail as selection to address you want to send email from.

[edit] Subscribe to the mailing list

You need to subscribe to the appropriate mailing-list in order to be able to send your patch(es) there; for patches against OE-Core the mailing list is openembedded-core@lists.openembedded.org and for patches against meta-oe and many other layers the list is openembedded-devel@lists.openembedded.org. See Mailing lists for subscription and further details.

[edit] Committing your patch

Commit with a concise and descriptive message - one that explains your changes in a way others get a short overview without looking at the code.

cd oe-core/ # or whereever you keep your clone of the repo
git add meta/recipes-devtools/flex
git commit -s # don't use the -m option but include my signature
   flex: backport Debian patches to fix generated code warnings
   
   The generated parser had warnings regarding signess and return check
   which makes Linux Kernel's perf tool from 3.4 release to fail without
   those patches.

All commit messages must include Signed-off-by (-s option to commit as above). For more guidelines on messages please see Commit Patch Message Guidelines.

Note that when adding multiple new recipes, each recipe should be added in a separate commit. For upgrades of existing recipes, the previous version should usually be deleted as part of the same commit to add the upgraded version.

[edit] Sending patches

There are two possible methods for submitting patches. Either one is acceptable; for a series containing a number of patches the pull request method is preferred although not mandatory.

[edit] Sending using git-send-email

To send just the top commit on your current branch (substitute mailing list address as appropriate):

git send-email --to=openembedded-core@lists.openembedded.org --confirm=always -M -1

For multiple commits you can substitute -1 above with -N (where N is the number of commits) or instead specify a revision before which to start e.g. HEAD~3, master etc.

Note: in either case if you are submitting a patch for meta-oe or any layer other than OE-Core, please add the appopriate prefix so that it is clear which layer the patch is intended to be applied to:

--subject-prefix="meta-oe][PATCH"

Please substitute "PATCH" with "PATCH v2" if you are submitting a revised version after addressing feedback (or v3, v4 etc.)

[edit] Sending via a pull request

Alternatively, for larger patch series it is preferable to send a pull request which not only includes the patch but also a pointer to a branch that can be pulled from. This involves making a local branch for your changes, pushing this branch to an accessible repository and then using the create-pull-request and send-pull-request scripts (supplied with OE-Core) to create and send a patch series with a link to the branch for review. Step-by-step instructions:

  1. Find a repository to push your changes to, and add this as a remote to your git working tree. If you're going to be submitting a lot of changes, some of the repositories have a corresponding -contrib repository which you can use for this purpose - access to these for OE-related work is open to anyone who requests it. Otherwise github or some other public git hosting service can suffice.
  2. Create a branch for your changes if you haven't already. Other than backports from master or fixing bugs that only occur in an older branch, this should be on top of the master branch.
  3. Push the branch to the remote.
  4. Run scripts/create-pull-request -u remote-name (where remote-name is the name of the remote where you'll be pushing the branch). For meta-oe and other layers where a single mailing list covers more than one layer you'll need to add -p "layername][PATCH" replacing layername with the name of the layer so that it is clear which layer the patches are intended for.
  5. The script will report that it has created a pull-XXXXX directory has been created. Edit the pull-XXXXX/0000-cover-letter.patch with your favourite text editor and change the title and top of the body as appropriate.
  6. Run scripts/send-pull-request -p pull-XXXXX -t openembedded-core@lists.openembedded.org (replacing openembedded-core@lists.openembedded.org with the appropriate mailing list address for layers other than OE-Core). Where there is a clear maintainer for the area you're changing it may also help to add -C maintainer@example.com.

[edit] Community review

Your patch will be sent to the mailing list and for some layers should be immediately visible on http://patches.openembedded.org/

If you get feedback in reply to your patch, you should make changes according to the feedback and submit the next version. Please remember to use --subject-prefix="PATCH v2", v3, v4 etc. to mark the patch iteration.

If your patch has not had any feedback after a few days it may have been missed or the appropriate reviewers may not currently be around; it is perfectly fine to reply to it yourself with a "ping" / reminder request for feedback.

[edit] Appendix

[edit] Steps for people which don't have SMTP access for git

Patches should not be sent as attachment but inline.

If you do not have SMTP 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).

A good mail client to do so is pine (or alpine) or mutt. For more information refer to Documentation/email-clients.txt in linux kernel sources.

Personal tools
Namespaces

Variants
Actions
Navigation
Categories
OE services
Toolbox