Differences

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

--- en:developers:documentation:submittingpatches [2018/03/27 14:12]
Kalle Valo [Format of patches] Mention about git-format-patch and git-send-email
+++ en:developers:documentation:submittingpatches [2019/06/23 09:14]
Thomas Nagy [Fixes line is incorrect] mention placement compared to signed-off-by
@@ Line 93: / Line 93: @@
 If a patch in a bigger patchset changes resubmit the whole patchset, even the patches which have not changes. The maintainers look at patchsets as a complete unit, usually they do not want to take patches individually from a patchset.
+===== Tree labels =====
+Labeling patches with what tree the patch should go to helps maintainers to prioritise and sort patches and avoids unnecessary emails, which saves everyone time and speeds up patch review. Here are some tips how to label wireless patches.
+If you want to target your patch to a specific release (for example that the patch should go -rc release not -next) you can inform the maintainer by adding the release number inside the PATCH brackets:
+<code>[PATCH 4.20] subsystem: fix foo</code>
+If you want to make it clear to the maintainer that the patch should NOT go to -rc release but to -next instead you can add "-next" to PATCH brackets:
+<code>[PATCH -next] subsystem: fix foo</code>
+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
+[PATCH mac80211-next] mac80211: implement very-cool-feature
+[PATCH wireless-drivers] ath10k: fix foo
+[PATCH wireless-drivers-next] ath10k: implement awesome-feature
+</code>
 ===== Sending large patches or multiple patches =====
@@ Line 256: / Line 277: @@
 commit log message header line text enclosed in parentheses and
 double quotes with no line breaks whatsoever.
+The fixes lines must be placed just above the signed-off-by lines.
 Example:
@@ Line 321: / Line 343: @@
 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 =====
+==== Do not top post and edit your quotes ====
+Top posting makes following email threads hard to follow and also it makes use of patchwork more difficult, which gets the maintainers grumpy as you are making their work more difficult. So do not top post and instead edit your quotes properly.
+<code>A: Because it messes up the order in which people normally read text.
+Q: Why is top-posting such a bad thing?
+A: Top-posting.
+Q: What is the most annoying thing in e-mail?
+A: No.
+Q: Should I include quotations after my reply?
+</code>
+More info: http://www.idallen.com/topposting.html
+==== Use RFC or RFT for patches not ready ====
+If the patches are not yet ready to be applied by the maintainer, mark them as RFC (Request For Comments) or RFT (Request For Test). This way the maintainer can easily see that the patch should not be applied yet. This saves a lot of maintainer's time.
+===== More references =====
 Here is a list of links to help you write better patches
@@ Line 329: / Line 371: @@
   * [[http://linux.yyz.us/patch-format.html|http://linux.yyz.us/patch-format.html]]
   * [[https://www.ozlabs.org/~akpm/stuff/tpp.txt|Andrew Morton's ''The perfect patch'']]
+  * [[http://lkml.kernel.org/r/20171026223701.GA25649@bhelgaas-glaptop.roam.corp.google.com|Make Bjorn's life easier (and grease the path of your patch)]]

Linux Wireless

User Tools

Site Tools

Differences

Page Tools