Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 9547c706 authored by Josh Triplett's avatar Josh Triplett Committed by Linus Torvalds
Browse files

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: default avatarJosh Triplett <josh@joshtriplett.org>
Acked-by: default avatarBorislav Petkov <bp@suse.de>
Cc: Rob Landley <rob@landley.net>
Cc: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 74a475ac

Documentation/SubmittingPatches

+9 −1
Original line number Diff line number Diff line
@@ -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