Submit patches to Openembedded: Difference between revisions

From KoanSoftware Wiki
Jump to navigation Jump to search
(Created page with "== Submit patches to Openembedded (core) == Submitting patches to oe-core is slightly different than what was used with oe-classic. You can tread the official [[http://www.opene…")
 
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Submit patches to Openembedded (core) ==  
== Submit patches to Openembedded (core) ==  
Submitting patches to oe-core is slightly different than what was used with oe-classic.
Contributions to the Yocto Project and OpenEmbedded are very welcome.
You can tread the official [[http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded Openembedded howto]]
You can read the official [[https://docs.yoctoproject.org/dev/contributor-guide/submit-changes.html Yocto contributor-guide]]


=== Set up git ===
=== Set up git ===


You have to setup a Google mail account (the same you used to subscribe to OE mailing list)
In this case I have a subscribed the openembedded-devel mailing list with a gmail.com account and I sign my patch with another account.
 
Properly configure git (using tekkub@gmail.com as an example user)
Properly configuring git (using tekkub@gmail.com as an example user)


On Debian / Ubuntu (Note: Fedora uses `yum` OpenSuse uses zypper or yast)
On Debian / Ubuntu (Note: Fedora uses `yum` OpenSuse uses zypper or yast)
Line 15: Line 14:
These are important to the commit meta-data
These are important to the commit meta-data


  git config --global user.name "Tekkub"
  git config --global user.name "Myself Me"
  git config --global user.email "tekkub@gmail.com"
  git config --global user.email "myname@mydomain.com"


Any Google Apps account
Any Google Apps account
Line 33: Line 32:


Add the modified file
Add the modified file
  git add meta/recipes-devtools/flex
  git add path/recipename


Add a comment
Add a comment including my signature "Signed-off-by: Your Name <name@domain.com>"
git commit


git commit -s
     recipename: brief description
     recipename: brief description
   
     * Longer description
     * Longer description
     * if
     * if
     * required
     * required


Please add the appopriate prefix so that it is clear which layer the patch is intended to be applied to:
 
  git format-patch -s --subject-prefix="oe][meta-oe][PATCH" -1
In case you are sending patches for meta-openembedded or any layer other than openembedded-core, please add the appropriate prefix so that it is clear which layer the patch is intended to be applied to:
 
  git format-patch --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.) 
 
For multiple commits you can substitute -1 above with -N (where N is the number of commits)
 


==== Sending using git-send-email ====
==== Sending using git-send-email ====


To send just the top commit on your current branch (substitute mailing list address as appropriate):
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
 
  git send-email --to=openembedded-core@lists.openembedded.org patchfilename
 
== Community review ==
 
Your patch will be sent to the mailing list and should be immediately visible on http://patches.openembedded.org/
.

Latest revision as of 09:06, 27 June 2024

Submit patches to Openembedded (core)

Contributions to the Yocto Project and OpenEmbedded are very welcome. You can read the official [Yocto contributor-guide]

Set up git

In this case I have a subscribed the openembedded-devel mailing list with a gmail.com account and I sign my patch with another account. Properly configure 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 "Myself Me"
git config --global user.email "myname@mydomain.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

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.

Move to oe-core directory or whereever you keep your clone of the repo

cd oe-core

Add the modified file

git add path/recipename

Add a comment including my signature "Signed-off-by: Your Name <name@domain.com>"

git commit -s
   recipename: brief description
   * Longer description
   * if
   * required


In case you are sending patches for meta-openembedded or any layer other than openembedded-core, please add the appropriate prefix so that it is clear which layer the patch is intended to be applied to:

git format-patch --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.)

For multiple commits you can substitute -1 above with -N (where N is the number of commits)


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 patchfilename

Community review

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