diff options
author | Josh Triplett <josh@joshtriplett.org> | 2014-04-03 17:48:29 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2014-04-03 19:21:06 -0400 |
commit | 9547c706d279392d53922c0f9d57a0b37a4dfcdc (patch) | |
tree | b421e9ae444fab550c1f0f9d1ff507c0ea31cfa5 | |
parent | 74a475acea49459721ae4b062d3da68c74259009 (diff) |
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>
-rw-r--r-- | Documentation/SubmittingPatches | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index c74e73c37dcc..53e6590263a1 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 | |||
112 | its behaviour. | 112 | its behaviour. |
113 | 113 | ||
114 | If the patch fixes a logged bug entry, refer to that bug entry by | 114 | If the patch fixes a logged bug entry, refer to that bug entry by |
115 | number and URL. | 115 | number and URL. If the patch follows from a mailing list discussion, |
116 | give a URL to the mailing list archive; use the https://lkml.kernel.org/ | ||
117 | redirector with a Message-Id, to ensure that the links cannot become | ||
118 | stale. | ||
119 | |||
120 | However, try to make your explanation understandable without external | ||
121 | resources. In addition to giving a URL to a mailing list archive or | ||
122 | bug, summarize the relevant points of the discussion that led to the | ||
123 | patch as submitted. | ||
116 | 124 | ||
117 | If you want to refer to a specific commit, don't just refer to the | 125 | If you want to refer to a specific commit, don't just refer to the |
118 | SHA-1 ID of the commit. Please also include the oneline summary of | 126 | SHA-1 ID of the commit. Please also include the oneline summary of |