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 [2017/05/16 05:17] Kalle Valo [Who to address] add link to ath10k wiki page |
en:developers:documentation:submittingpatches [2017/05/26 05:48] Kalle Valo Add frequent problem "Commit reference is wrong" |
||
|---|---|---|---|
| Line 32: | Line 32: | ||
| Do note that drivers might have special requirements, the best is to check them from the corresponding wiki page. Here's a list for few of them: | Do note that drivers might have special requirements, the best is to check them from the corresponding wiki page. Here's a list for few of them: | ||
| - | * [[en/users/drivers/ath10k/sources#submitting_patches|ath10k]] | + | * [[en/users/drivers/ath10k/submittingpatches|ath10k]] |
| ===== Checking state of patches from patchwork ===== | ===== Checking state of patches from patchwork ===== | ||
| Line 243: | Line 243: | ||
| 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]] and add Signed-off-by to the commit log. | ||
| + | |||
| + | ==== Format issues ==== | ||
| + | |||
| + | Patch is somehow whitespace damaged, for example tabs converted to spaces, extra new lines or other modifications which prevent applying the patch without manual fixing. Or the mail is in HTML format which most of the mailing lists even block silently. | ||
| + | |||
| + | 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 ===== | ===== More patch work references ===== | ||
en/developers/documentation/submittingpatches.txt ยท Last modified: 2024/05/17 14:52 by Kalle Valo
Page Tools
