Differences

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

--- en:developers:documentation:submittingpatches [2017/05/26 06:05]
Kalle Valo Add frequent problem: "Commit title is wrong"
+++ en:developers:documentation:submittingpatches [2018/01/23 08:19]
Kalle Valo [Changelog missing] add a missing verb
@@ Line 232: / Line 232: @@
 ==== Changelog missing ====
-When sending a new version of a patch or patchset you should **always** add a changelog so that maintainer can easily what has changed.
+When sending a new version of a patch or patchset you should **always** add a changelog so that maintainer can easily see what has changed.
 If you have just one patch you can add the changelog after the ''%%---%%'' (three dashes) line.
-If you have multiples patches (called a patchset) add the changelog to the cover letter. You can create the cover letter with switch ''--cover-letter'':
+If you have multiples patches (called a patchset) add the changelog to the cover letter. You can create the cover letter with the switch ''--cover-letter'':
   git format-patch --subject-prefix="PATCH v2" --cover-letter
@@ Line 248: / Line 248: @@
 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]]
+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]]. See [[en/developers/Documentation/git-guide|linux-wireless git guide]] for more information.
 ==== Fixes line is incorrect ====
@@ Line 287: / Line 287: @@
 ==== Commit title is wrong ====
-The format of the commit title is name of driver, followed by colon, followed by space and then followed by the actual title. You can use ''git log'' to check older commits and see what prefix was used:
+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>
@@ Line 305: / Line 305: @@
 a5f390562a37 mwifiex: add 802.11AC support
 </code>
+==== Too many patches ====
+The recommend size is 10-12 patches per patchset. More than that it gets difficult for reviewers and maintainers. Of course there's no hard rule, for simple patches more than that might be ok but then again for more complex patches even 10 patches per patchset might be too much.
+==== Resubmit the whole patchset =====
+Even if just one patch has changed in a patch series resubmit the whole patchset (and remember to increase the version number), do not just resubmit that one changed patch. The reason is that it's difficult to apply patches in correct order when some of them are submitted separately.
+==== Commit log does not answer "Why?" ====
+The commit log should //always// answer the question "Why?" and describe the reason what
+motivated to implement the patch. This is the most important part of the commit log as this helps maintainers, backports, distros etc to make decisions if the patch is important for them or not and to what release it should go.
+The commit log needs to tell why you wrote the patch. If you fixed a bug give a short summary of the bug (can be a long one as well, of course) from user's point of view, and if there's a publically available bug report include a link to that. If you are fixing a warning from a compiler or a static checker add the warning from tool. Or if it's just code cleanup or fixing a theoretical issue, and does not have practical user visible changes, mention that also.
 ===== More patch work references =====

Linux Wireless

User Tools

Site Tools

Differences

Page Tools