| 1 |
# How to Submit Patches for libteam # |
| 2 |
======================================= |
| 3 |
|
| 4 |
Send changes to libteam as patches to [email protected] |
| 5 |
with copy to [email protected]. |
| 6 |
|
| 7 |
Avoid using attachments because usually it doesn't work. |
| 8 |
In another words, inline the patch inside the e-mail's body. |
| 9 |
|
| 10 |
The simplest workflow to send changes is using git. The following |
| 11 |
steps will guide you to do the task. |
| 12 |
|
| 13 |
1) Clone the source code on your local machine. |
| 14 |
$ git clone https://github.com/jpirko/libteam.git |
| 15 |
|
| 16 |
2) Create a local branch for you |
| 17 |
$ cd libteam |
| 18 |
$ git checkout -b testbranch |
| 19 |
|
| 20 |
3) Do your changes |
| 21 |
<<do some changes>> |
| 22 |
|
| 23 |
4) Commit them to the repository |
| 24 |
$ git commit -a -s |
| 25 |
|
| 26 |
5) Optionally, you can verify how it looks like in the repo |
| 27 |
$ git show |
| 28 |
|
| 29 |
6) Extract the patch in a standard format into /tmp directory |
| 30 |
$ git format-patch origin -o /tmp --subject-prefix "patch libteam" |
| 31 |
|
| 32 |
7) Use checkpatch script from the kernel sources to find possible styling |
| 33 |
issues in your patch: |
| 34 |
$ path-to-kernel-sources/scripts/checkpatch.pl /tmp/0001-somepatch.patch |
| 35 |
|
| 36 |
8) Use git send-email to send the patch*. |
| 37 |
$ git send-email /tmp/0001-somepatch.patch \ |
| 38 |
[email protected] [email protected] |
| 39 |
|
| 40 |
And you are done :) |
| 41 |
|
| 42 |
* You may need to configure smtp in order to send emails, so please |
| 43 |
check the "Example" section in the reference [3] below as a start. |
| 44 |
|
| 45 |
Additional references about git: |
| 46 |
[1] http://git-scm.com/docs/gittutorial |
| 47 |
[2] http://git-scm.com/docs/gitworkflows.html |
| 48 |
[3] http://git-scm.com/docs/git-send-email |
| 49 |
[4] http://git-scm.com/book |