Re: [PATCH v2] Documentation/SubmittingPatches: discuss In-Reply-To

[Frederic Weisbecker <fweisbec@gmail.com>]

On Thu, Nov 05, 2015 at 03:21:47PM -0500, Chris Metcalf wrote:
> 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>

ACK!

Thanks!

> ---
>  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
>