en:developers:documentation:submittingpatches
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
en:developers:documentation:submittingpatches [2017/08/03 04:47] Kalle Valo Add "Commit log does not answer "Why?"" |
en:developers:documentation:submittingpatches [2018/03/27 14:12] Kalle Valo [Format of patches] Mention about git-format-patch and git-send-email |
||
|---|---|---|---|
| Line 35: | Line 35: | ||
| ===== Checking state of patches from patchwork ===== | ===== Checking state of patches from patchwork ===== | ||
| - | All wireless patches are tracked in [[https://patchwork.kernel.org/project/linux-wireless/list/|linux-wireless patchwork project]] (only exception being ath10k which has its own [[https://patchwork.kernel.org/project/ath10k/list/?state=*|ath10k patchwork project]]). From patchwork you can check the state of the patch and to whom it is assigned. Here's a quick link to see all the patches, no matter what's the state: | + | All wireless patches are tracked in [[https://patchwork.kernel.org/project/linux-wireless/list/|linux-wireless patchwork project]]. From patchwork you can check the state of the patch and to whom it is assigned. Here's a quick link to see all the patches, no matter what's the state: |
| [[https://patchwork.kernel.org/project/linux-wireless/list/?state=*]] | [[https://patchwork.kernel.org/project/linux-wireless/list/?state=*]] | ||
| - | Always avoid contacting maintainers directly, they get way too much email already. Instead use the link above to find your patch and see the status. Only in last resort contact the maintainers, and do that by replying to your own patch and ask for status. | + | Always avoid contacting maintainers directly, they get way too much email already. Instead use the link above to find your patch and see the status. Only in last resort contact the maintainers, and do that by replying to your own patch and ask for status. Do not top post! |
| Different patchwork states and their meanings: | Different patchwork states and their meanings: | ||
| Line 111: | Line 111: | ||
| ===== Format of patches ===== | ===== Format of patches ===== | ||
| - | We prefer patches to be inline-text at the end of the body of the e-mail. You can use git-diff or the like to generate the patch. Additionally note that we prefer to apply patches with -p1. A header as follows is then acceptable: | + | We prefer patches to be inline-text at the end of the body of the e-mail. It's strongly recommended to use git-format-patch and git-send-email tools to submit patches as they use the correct format automatically. Additionally note that we prefer to apply patches with git-am (using the -p1 diff format). A header as follows is then acceptable: |
| Line 232: | Line 232: | ||
| ==== Changelog missing ==== | ==== Changelog missing ==== | ||
| - | When sending a new version of a patch or patchset you should **always** add a changelog so that maintainer can easily what has changed. | + | When sending a new version of a patch or patchset you should **always** add a changelog so that maintainer can easily see what has changed. |
| If you have just one patch you can add the changelog after the ''%%---%%'' (three dashes) line. | If you have just one patch you can add the changelog after the ''%%---%%'' (three dashes) line. | ||
| - | If you have multiples patches (called a patchset) add the changelog to the cover letter. You can create the cover letter with switch ''--cover-letter'': | + | If you have multiples patches (called a patchset) add the changelog to the cover letter. You can create the cover letter with the switch ''--cover-letter'': |
| git format-patch --subject-prefix="PATCH v2" --cover-letter | git format-patch --subject-prefix="PATCH v2" --cover-letter | ||
en/developers/documentation/submittingpatches.txt ยท Last modified: 2024/05/17 14:52 by Kalle Valo
Page Tools
