From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752711AbaBVV5B (ORCPT ); Sat, 22 Feb 2014 16:57:01 -0500 Received: from merlin.infradead.org ([205.233.59.134]:36986 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751547AbaBVV5A (ORCPT ); Sat, 22 Feb 2014 16:57:00 -0500 Message-ID: <53091D26.4020900@infradead.org> Date: Sat, 22 Feb 2014 13:56:54 -0800 From: Randy Dunlap User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.0 MIME-Version: 1.0 To: Josh Triplett , Andrew Morton , Borislav Petkov , Rob Landley , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH RESEND 2/3] SubmittingPatches: Add recommendation for mailing list references References: <6f68169828300d32c4266a6d68c5fcf272dfea33.1393099913.git.josh@joshtriplett.org> <02737d618daecb42e33308ce5dabd53ed3cf14f3.1393099913.git.josh@joshtriplett.org> In-Reply-To: <02737d618daecb42e33308ce5dabd53ed3cf14f3.1393099913.git.josh@joshtriplett.org> Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > Acked-by: Borislav Petkov > --- > 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