SubmittingPatches: Add recommendation for mailing list references
PATCH 2/3 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 <[email protected]>
--- Documentation/SubmittingPatches | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)
Documentation/SubmittingPatches +9 -1
@@ -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
Signature · 1 line
1.8.5.1
Quoted 8 lines · Josh Triplett
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 <[email protected]>
Yep.
Acked-by Borislav Petkov <[email protected]>
Signature · 5 lines
Regards/Gruss,
Boris.
Sent from a fat crate under my desk. Formatting is fine.
--