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 [2022/02/18 13:38] Kalle Valo [Who to address] don't use wireless-drivers |
en:developers:documentation:submittingpatches [2022/05/18 05:13] Kalle Valo [Commit title is wrong] should be informative and unique |
||
|---|---|---|---|
| Line 13: | Line 13: | ||
| ===== Prior to sending patches ===== | ===== Prior to sending patches ===== | ||
| - | Please **DO NOT** PGP sign patches sent to //linux-wireless//. The reason is that signing patches will encapsulate them into MIME and thereby mangle the patch. Also, please note that we prefer patches inline rather than attachments. | + | Please **DO NOT** PGP sign patches sent to public lists. The reason is that signing patches will encapsulate them into MIME and thereby mangle the patch. Also, please note that we prefer patches inline rather than attachments. And no HTML mail, our lists reject those automatically. |
| + | |||
| + | And carefully read [[http://www.infradead.org/~dwmw2/email.html|our email etiquette]], that saves everyone's time. | ||
| Line 126: | Line 128: | ||
| Alternatively you can specify the exact tree you are targetting by adding the name of the git tree inside PATCH brackets: | Alternatively you can specify the exact tree you are targetting by adding the name of the git tree inside PATCH brackets: | ||
| - | <code>[PATCH mac80211] mac80211: fix foo | + | <code>[PATCH wireless] mac80211: fix foo |
| - | [PATCH mac80211-next] mac80211: implement very-cool-feature | + | [PATCH wireless-next] mac80211: implement very-cool-feature |
| - | [PATCH wireless-drivers] ath10k: fix foo | + | [PATCH wireless] ath10k: fix foo |
| - | [PATCH wireless-drivers-next] ath10k: implement awesome-feature | + | [PATCH wireless-next] ath10k: implement awesome-feature |
| </code> | </code> | ||
| Line 330: | Line 332: | ||
| Fixes: c742e623e941 ("mwifiex: sdio card reset enhancement") | Fixes: c742e623e941 ("mwifiex: sdio card reset enhancement") | ||
| + | Here's how one can configure git to provide the fixes tag in correct format: | ||
| + | |||
| + | $ git config --global --add alias.fixes 'show -q --format=fixes' | ||
| + | $ git config --global --add pretty.fixes 'Fixes: %h ("%s")' | ||
| + | $ git config --global --add core.abbrev 12 | ||
| + | $ git fixes ba9177fcef21 | ||
| + | Fixes: ba9177fcef21 ("ath11k: Add basic WoW functionalities") | ||
| ==== Commit reference is wrong ==== | ==== Commit reference is wrong ==== | ||
| Line 356: | Line 365: | ||
| ==== Commit title is wrong ==== | ==== Commit title is wrong ==== | ||
| - | The correc tformat for the commit title is name of driver, followed by a colon, followed by a space and then followed by the actual title. You can use ''git log'' to check older commits and see what prefix was used: | + | The correct format for the commit title is name of driver, followed by a colon, followed by a space and then followed by the actual title. Also the title should be informative and unique, so something like "fix a bug" is not a good title. |
| + | |||
| + | For examples uou can use ''git log'' to check older commits and see what prefix was used: | ||
| <code> | <code> | ||
en/developers/documentation/submittingpatches.txt · Last modified: 2024/02/01 20:12 by Jeff Johnson
Page Tools
