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/05/18 12:15] Kalle Valo [Whitespace damage] Rename section Whitespace damage to Format issues |
en:developers:documentation:submittingpatches [2017/05/26 06:08] Kalle Valo [Commit title is wrong] Fix spelling |
||
---|---|---|---|
Line 249: | Line 249: | ||
The best way to avoid all formatting issues is to use [[https://www.kernel.org/pub/software/scm/git/docs/git-send-email.html|git send-email]] | The best way to avoid all formatting issues is to use [[https://www.kernel.org/pub/software/scm/git/docs/git-send-email.html|git send-email]] | ||
+ | |||
+ | ==== Fixes line is incorrect ==== | ||
+ | |||
+ | The correct format for the commit references in Fixes line is the 12 initial digits | ||
+ | of the SHA1_ID of the commit, followed by a space, followed by the | ||
+ | commit log message header line text enclosed in parentheses and | ||
+ | double quotes with no line breaks whatsoever. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | Fixes: c742e623e941 ("mwifiex: sdio card reset enhancement") | ||
+ | |||
+ | ==== Commit reference is wrong ==== | ||
+ | |||
+ | The correct format for the commit references in commit logs is to start with the string "commit", followed by a space, followed 12 initial digits | ||
+ | of the SHA1_ID of the commit, followed by a space and followed by the | ||
+ | commit log message header line text enclosed in parentheses. | ||
+ | |||
+ | Example: | ||
+ | |||
+ | <code> | ||
+ | commit f99a6abe59e096cc2c753e667c19f22022e3bef4 | ||
+ | Author: Sara Sharon <sara.sharon@intel.com> | ||
+ | Date: Sun Mar 5 18:35:02 2017 +0200 | ||
+ | |||
+ | iwlwifi: mvm: memset binding before setting values | ||
+ | | ||
+ | The changes in commit 9415af7f306b ("iwlwifi: mvm: support new binding | ||
+ | API") assigned values that were later memset to 0. Move the memset | ||
+ | earlier. | ||
+ | | ||
+ | Fixes: 9415af7f306b ("iwlwifi: mvm: support new binding API") | ||
+ | Signed-off-by: Sara Sharon <sara.sharon@intel.com> | ||
+ | Signed-off-by: Luca Coelho <luciano.coelho@intel.com> | ||
+ | </code> | ||
+ | |||
+ | ==== 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: | ||
+ | |||
+ | <code> | ||
+ | $ git log --oneline --follow --no-merges -20 drivers/net/wireless/marvell/mwifiex/11ac.c | ||
+ | 277b024e5e3d mwifiex: move under marvell vendor directory | ||
+ | 65da33f5557f mwifiex: update Copyright to 2014 | ||
+ | cf831ffe4473 mwifiex: fix IE parsing issues | ||
+ | d51246481c7f mwifiex: save and copy AP's VHT capability info correctly | ||
+ | 5f6d5983394f mwifiex: add VHT support for TDLS | ||
+ | 9ed230bcbab7 mwifiex: pass ieee80211_vht_cap to mwifiex_fill_vht_cap_tlv | ||
+ | 406d702b47a2 mwifiex: improve readability in 11ac mcsmap to maxrate conversion | ||
+ | 89467d8ca21b mwifiex: make 11ac mcs rate tables global and const | ||
+ | 7abf4129e6df mwifiex: make use of IEEE80211_VHT_MCS_NOT_SUPPORTED | ||
+ | 0648f3a4b0e9 mwifiex: correct bss_mode check while appending vht operation IE | ||
+ | 2b6254dacfe6 mwifiex: use separate AMPDU tx/rx window sizes in 11ac networks | ||
+ | 83c78da983d6 mwifiex: add support to configure VHT for AP mode | ||
+ | a5f390562a37 mwifiex: add 802.11AC support | ||
+ | </code> | ||
===== More patch work references ===== | ===== More patch work references ===== |