Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754121AbcCYSmx (ORCPT ); Fri, 25 Mar 2016 14:42:53 -0400 Received: from mleia.com ([178.79.152.223]:34242 "EHLO mail.mleia.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753820AbcCYSmw (ORCPT ); Fri, 25 Mar 2016 14:42:52 -0400 From: Vladimir Zapolskiy To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] SubmittingPatches: add a rule describing how to submit reverted changes Date: Fri, 25 Mar 2016 20:42:47 +0200 Message-Id: <1458931367-23143-1-git-send-email-vz@mleia.com> X-Mailer: git-send-email 2.1.4 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-49551924 X-CRM114-CacheID: sfid-20160325_184705_184253_61DC9161 X-CRM114-Status: GOOD ( 13.31 ) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1643 Lines: 43 The change adds a basic formal rule for developers about how to format subject and commit message of reverted changes. The rule is based on discussion from http://www.spinics.net/lists/arm-kernel/msg75667.html : RMK> I think it's sensible to keep at least the summary line RMK> of a 'git revert' intact rather than inventing our own. Signed-off-by: Vladimir Zapolskiy --- The motivation of this change is to avoid ambiguity and discussions of the format of reverted changes in future, an example of such a discussion is found here: https://lkml.org/lkml/2016/3/24/536 On practice only a statistically minor number of accepted reverted changes has its own duplicated subsystem designator. Documentation/SubmittingPatches | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 8c79f1d..4fff51b 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -670,6 +670,14 @@ that developers understand the order in which the patches should be applied and that they have reviewed or applied all of the patches in the patch series. +In case if a patch is generated by 'git revert' of some original +change, the subject should not be edited and it should look like +'Revert "original summary phrase"', target original subsystem can be +taken from the original summary phrase, also the commit ID of +the original change must be specified above the commit text message: + + "This reverts commit ". + A couple of example Subjects: Subject: [PATCH 2/5] ext2: improve scalability of bitmap searching -- 2.1.4