From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752391AbaBVUMr (ORCPT ); Sat, 22 Feb 2014 15:12:47 -0500 Received: from relay4-d.mail.gandi.net ([217.70.183.196]:51651 "EHLO relay4-d.mail.gandi.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752084AbaBVUMc (ORCPT ); Sat, 22 Feb 2014 15:12:32 -0500 X-Originating-IP: 50.43.14.201 Date: Sat, 22 Feb 2014 12:12:26 -0800 From: Josh Triplett To: Andrew Morton , Borislav Petkov , Rob Landley , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH RESEND 2/3] SubmittingPatches: Add recommendation for mailing list references Message-ID: <02737d618daecb42e33308ce5dabd53ed3cf14f3.1393099913.git.josh@joshtriplett.org> References: <6f68169828300d32c4266a6d68c5fcf272dfea33.1393099913.git.josh@joshtriplett.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <6f68169828300d32c4266a6d68c5fcf272dfea33.1393099913.git.josh@joshtriplett.org> User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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. + +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 -- 1.9.0