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 [2020/02/13 16:29] Kalle Valo Add Co-developed-by |
en:developers:documentation:submittingpatches [2020/10/08 08:36] Kalle Valo Add a section for new drivers |
||
---|---|---|---|
Line 155: | 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 recommendations are: | ||
+ | |||
+ | * follow [[https://www.kernel.org/doc/html/latest/process/coding-style.html|Linux kernel coding style]] | ||
+ | * use one of [[https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/LICENSES/preferred|preferred licenses]] | ||
+ | * 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 available with an acceptable license in [[https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/|linux-firmware]] | ||
+ | * for review submit the driver as one file per patch, for easier review | ||
+ | * 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 moving the driver, example: https://git.kernel.org/linus/5625f965d764 | ||
===== Examples of a patches ===== | ===== Examples of a patches ===== | ||
Line 264: | Line 278: | ||
==== 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 358: | Line 373: | ||
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 368: | Line 387: | ||
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by | 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 ===== |