From: Chris Metcalf <cmetcalf@ezchip.com>
To: Steven Rostedt <rostedt@goodmis.org>, Jonathan Corbet <corbet@lwn.net>,
        Peter Zijlstra <peterz@infradead.org>,
        Gilad Ben Yossef <giladb@ezchip.com>, Ingo Molnar <mingo@kernel.org>,
        Andrew Morton <akpm@linux-foundation.org>,
        Rik van Riel <riel@redhat.com>, Tejun Heo <tj@kernel.org>,
        "Frederic Weisbecker" <fweisbec@gmail.com>,
        Thomas Gleixner <tglx@linutronix.de>,
        "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>,
        Christoph Lameter <cl@linux.com>,
        Viresh Kumar <viresh.kumar@linaro.org>,
        Catalin Marinas <catalin.marinas@arm.com>,
        Will Deacon <will.deacon@arm.com>,
        Andy Lutomirski <luto@amacapital.net>, <linux-kernel@vger.kernel.org>,
        <linux-doc@vger.kernel.org>
CC: Chris Metcalf <cmetcalf@ezchip.com>
Subject: [PATCH v2] Documentation/SubmittingPatches: discuss In-Reply-To
Date: Thu, 5 Nov 2015 15:21:47 -0500
Message-ID: <1446754907-29641-1-git-send-email-cmetcalf@ezchip.com>
In-Reply-To: <20151105142335.52ce33bc@gandalf.local.home>
MIME-Version: 1.0
Content-Type: text/plain
SpamDiagnosticOutput: 1:23
SpamDiagnosticMetadata: NSPM
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Nov 2015 20:22:09.8719
 (UTC)
X-MS-Exchange-CrossTenant-Id: 0fc16e0a-3cd3-4092-8b2f-0a42cff122c3
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=0fc16e0a-3cd3-4092-8b2f-0a42cff122c3;Ip=[12.216.194.146];Helo=[ld-1.internal.tilera.com]
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB4PR02MB0430
X-Microsoft-Exchange-Diagnostics: 1;DB4PR02MB0367;2:QggkyWcCWEeDARDJ6HoeHWKQjibDaMu8nug/pxJvBa/FrHAqXYmDpo1+ccdqiZ4k6XsQvMEN+J/O4NYudaCWCzPdiY/dVvdTW6MXc10es7z0jlus6gDuqusXWuRXSb8jFzNxE4J5DHi9jSsV9cNMp1Ow2QJWs07MLVt7ZMVAFeY=;23:AEPcR9ygvvRH5xBYNZQDXvQf98uSeJH7hXJLHuWl4JvRqnHrVkFA1wKZl1LomF1Zo3laZ4yVkZoT1ScY1Q0wgl75jO9Pl9PZLMjiUO5mYriIldqzXr2HKEVVTnd9aI///+z2t5o5T6P+wlntzn4tvSTb8CWQ5IHQK8UJcwbp4XStVl01ja63KcXdAQ/HkN/n
X-OriginatorOrg: ezchip.com
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Length: 1591
Lines: 37

Add a paragraph suggesting best practices for when to link patches
to previous LKML messages via In-Reply-To.

Signed-off-by: Chris Metcalf <cmetcalf@ezchip.com>
---
 Documentation/SubmittingPatches | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index fd89b04d34f0..9f61620f34ef 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -675,6 +675,16 @@ A couple of example Subjects:
     Subject: [patch 2/5] ext2: improve scalability of bitmap searching
     Subject: [PATCHv2 001/207] x86: fix eflags tracking
 
+It can be helpful to manually add In-Reply-To: headers to a patch
+(e.g., when using "git send email") to associate the patch with
+previous relevant discussion, e.g. to link a bug fix to the email with
+the bug report.  However, for a multi-patch series, it is generally
+best to avoid using In-Reply-To: to link to older versions of the
+series.  This way multiple versions of the patch don't become an
+unmanageable forest of references in email clients.  If a link is
+helpful, you can use the https://lkml.kernel.org/ redirector (e.g., in
+the cover email text) to link to an earlier version of the patch series.
+
 The "from" line must be the very first line in the message body,
 and has the form:
 
-- 
2.1.2

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/