aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2014-04-03 21:48:29 (GMT)
committerLinus Torvalds <torvalds@linux-foundation.org>2014-04-03 23:21:06 (GMT)
commit9547c706d279392d53922c0f9d57a0b37a4dfcdc (patch)
treeb421e9ae444fab550c1f0f9d1ff507c0ea31cfa5 /Documentation/SubmittingPatches
parent74a475acea49459721ae4b062d3da68c74259009 (diff)
downloadkernel_replicant_linux-9547c706d279392d53922c0f9d57a0b37a4dfcdc.zip
kernel_replicant_linux-9547c706d279392d53922c0f9d57a0b37a4dfcdc.tar.gz
kernel_replicant_linux-9547c706d279392d53922c0f9d57a0b37a4dfcdc.tar.bz2
SubmittingPatches: add recommendation for mailing list references
SubmittingPatches already mentions referencing bugs fixed by a commit, but doesn't mention citing relevant mailing list discussions. Add a note to that effect, along with a recommendation to use the https://lkml.kernel.org/ redirector. Portions based on text from git's SubmittingPatches. Signed-off-by: Josh Triplett <josh@joshtriplett.org> Acked-by: Borislav Petkov <bp@suse.de> Cc: Rob Landley <rob@landley.net> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/SubmittingPatches')
-rw-r--r--Documentation/SubmittingPatches10
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index c74e73c..53e6590 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -112,7 +112,15 @@ to do frotz", as if you are giving orders to the codebase to change
its behaviour.
If the patch fixes a logged bug entry, refer to that bug entry by
-number and URL.
+number and URL. If the patch follows from a mailing list discussion,
+give a URL to the mailing list archive; use the https://lkml.kernel.org/
+redirector with a Message-Id, to ensure that the links cannot become
+stale.
+
+However, try to make your explanation understandable without external
+resources. In addition to giving a URL to a mailing list archive or
+bug, summarize the relevant points of the discussion that led to the
+patch as submitted.
If you want to refer to a specific commit, don't just refer to the
SHA-1 ID of the commit. Please also include the oneline summary of