Differences

This shows you the differences between two versions of the page.

--- 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 05:48]
Kalle Valo Add frequent problem "Commit reference is wrong"
@@ 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]]
+==== 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>
 ===== More patch work references =====

Linux Wireless

User Tools

Site Tools

Differences

Page Tools