linux-kernel - [PATCH] Documentation/email-clients.txt: discuss In-Reply-To

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <1445616781-8212-1-git-send-email-cmetcalf@ezchip.com>
Date:	Fri, 23 Oct 2015 12:13:01 -0400
From:	Chris Metcalf <cmetcalf@...hip.com>
To:	Peter Zijlstra <peterz@...radead.org>,
	Gilad Ben Yossef <giladb@...hip.com>,
	Steven Rostedt <rostedt@...dmis.org>,
	Ingo Molnar <mingo@...nel.org>,
	Andrew Morton <akpm@...ux-foundation.org>,
	Rik van Riel <riel@...hat.com>, Tejun Heo <tj@...nel.org>,
	Frederic Weisbecker <fweisbec@...il.com>,
	Thomas Gleixner <tglx@...utronix.de>,
	"Paul E. McKenney" <paulmck@...ux.vnet.ibm.com>,
	Christoph Lameter <cl@...ux.com>,
	Viresh Kumar <viresh.kumar@...aro.org>,
	Catalin Marinas <catalin.marinas@....com>,
	Will Deacon <will.deacon@....com>,
	Andy Lutomirski <luto@...capital.net>,
	<linux-kernel@...r.kernel.org>, Jonathan Corbet <corbet@....net>,
	<linux-doc@...r.kernel.org>
CC:	Chris Metcalf <cmetcalf@...hip.com>
Subject: [PATCH] Documentation/email-clients.txt: discuss In-Reply-To

In-Reply-To: <20151023090459.GW17308@...ns.programming.kicks-ass.net>

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

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

diff --git a/Documentation/email-clients.txt b/Documentation/email-clients.txt
index 3fa450881ecb..547c54a2f4e0 100644
--- a/Documentation/email-clients.txt
+++ b/Documentation/email-clients.txt
@@ -39,6 +39,16 @@ you avoid some possible charset problems.
 Email clients should generate and maintain References: or In-Reply-To:
 headers so that mail threading is not broken.
 
+When manually adding In-Reply-To: headers to a patch (e.g., using `git
+send email`), use common sense to associate the patch with previous
+relevant discussion, e.g. link a bug fix to the email with the bug report.
+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 an
+"http://lkml.kernel.org/r/MESSAGEID" URL (e.g., in the cover email
+text) to link to an earlier version of the patch series.
+
 Copy-and-paste (or cut-and-paste) usually does not work for patches
 because tabs are converted to spaces.  Using xclipboard, xclip, and/or
 xcutsel may work, but it's best to test this for yourself or just avoid
-- 
2.1.2

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