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 [2019/06/23 09:14] Thomas Nagy [Fixes line is incorrect] mention placement compared to signed-off-by |
en:developers:documentation:submittingpatches [2020/10/12 13:19] Kalle Valo [New driver] overview of the driver |
||
|---|---|---|---|
| Line 33: | Line 33: | ||
| * [[en/users/drivers/ath10k/submittingpatches|ath10k]] | * [[en/users/drivers/ath10k/submittingpatches|ath10k]] | ||
| + | * [[en/users/drivers/ath11k/submittingpatches|ath11k]] | ||
| ===== Checking state of patches from patchwork ===== | ===== Checking state of patches from patchwork ===== | ||
| Line 154: | Line 155: | ||
| Please also read the [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html|official Linux SubmittingPatches]] documentation, especially the **[[https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin|Developer's Certificate of Origin]]**. Do not submit patches unless you have read, understood and agreed to the certificate. | Please also read the [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html|official Linux SubmittingPatches]] documentation, especially the **[[https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin|Developer's Certificate of Origin]]**. Do not submit patches unless you have read, understood and agreed to the certificate. | ||
| + | |||
| + | ===== New driver ===== | ||
| + | |||
| + | For submitting a new wireless driver the requirements are: | ||
| + | |||
| + | * follow [[https://www.kernel.org/doc/html/latest/process/coding-style.html|Linux kernel coding style]] | ||
| + | * use [[https://www.kernel.org/doc/html/latest/process/license-rules.html|SPDX tags]] | ||
| + | * use either cfg80211 or mac80211, depending on the firmware architecture (no custom 802.11 stack in the driver) | ||
| + | * have firmware images submitted for [[https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/|linux-firmware]] with an acceptable license allowing redistribution | ||
| + | * document Device Tree usage in [[https://www.kernel.org/doc/html/latest/devicetree/bindings/submitting-patches.html|devicetree bindings]] and review them with DT maintainers | ||
| + | * in the commit log/cover letter provide an overview of the driver | ||
| + | * what hardware the driver supports | ||
| + | * what features are supported (client, AP, mesh modes etc) | ||
| + | * for review submit the driver as one file per patch, to make it easier for the reviewers | ||
| + | * example: https://lore.kernel.org/linux-wireless/20200623110000.31559-1-ajay.kathat@microchip.com/ | ||
| + | * final commit (after the review) will be one big patch | ||
| + | * for staging drivers the final patch will be just a small patch moving the driver, example: https://git.kernel.org/linus/5625f965d764 | ||
| + | |||
| + | There's also a list of [[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/LICENSES/preferred|preferred licenses]] available. | ||
| ===== Examples of a patches ===== | ===== Examples of a patches ===== | ||
| Line 263: | Line 283: | ||
| ==== Signed-off-by missing ==== | ==== Signed-off-by missing ==== | ||
| - | Read [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin|Developer's Certificate of Origin]] and add Signed-off-by to the commit log. | + | Read [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin|Developer's Certificate of Origin]]. Do not submit patches unless you have read, understood and agreed to the certificate. |
| ==== Format issues ==== | ==== Format issues ==== | ||
| Line 357: | Line 378: | ||
| More info: http://www.idallen.com/topposting.html | More info: http://www.idallen.com/topposting.html | ||
| + | |||
| + | ==== Do not send HTML mail ==== | ||
| + | |||
| + | linux-wireless mailing list drops all mail using HTML, so don't use it. | ||
| ==== Use RFC or RFT for patches not ready ==== | ==== Use RFC or RFT for patches not ready ==== | ||
| Line 362: | Line 387: | ||
| If the patches are not yet ready to be applied by the maintainer, mark them as RFC (Request For Comments) or RFT (Request For Test). This way the maintainer can easily see that the patch should not be applied yet. This saves a lot of maintainer's time. | If the patches are not yet ready to be applied by the maintainer, mark them as RFC (Request For Comments) or RFT (Request For Test). This way the maintainer can easily see that the patch should not be applied yet. This saves a lot of maintainer's time. | ||
| + | ==== Use Co-developed-by when multiple authors ==== | ||
| + | |||
| + | When a patch has multiple authors you should use Co-developed-by tag: | ||
| + | |||
| + | https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by | ||
| + | |||
| + | ==== Maximum of 7-12 patches per patchset ==== | ||
| + | |||
| + | If you want your patches reviewed smoothly submit maximum of 7-12 patches per patchset. If the patches are bigger don't send more than 7 patches. But if they smaller, or trivial patches, 12 patches is ok. But anything more than 12 patches and you will get reviewers grumpy (read: it takes longer to get your patches reviewed and applied). | ||
| + | |||
| + | But you can submit multiple patchsets, just try to throttle it down to avoid bufferbloat in patchwork, for example you can send a new patchset every other day. And don't forget to document the dependencies in the cover letter ("this patchset depends on patchset B"). | ||
| ===== More references ===== | ===== More references ===== | ||
en/developers/documentation/submittingpatches.txt · Last modified: 2024/02/01 20:12 by Jeff Johnson
Page Tools
