On 02/22/2014 12:12 PM, Josh Triplett wrote: > 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@xxxxxxxxxxxxxxxx> > Acked-by: Borislav Petkov <bp@xxxxxxx> > --- > Documentation/SubmittingPatches | 10 +++++++++- > 1 file changed, 9 insertions(+), 1 deletion(-) > > 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. Some of us don't know what that looks like. Could we have an example? > +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 > -- ~Randy -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
