From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753042AbaJ0Tvx (ORCPT ); Mon, 27 Oct 2014 15:51:53 -0400 Received: from hofr.at ([212.69.189.236]:54313 "EHLO mail.hofr.at" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752997AbaJ0Tvw (ORCPT ); Mon, 27 Oct 2014 15:51:52 -0400 Date: Mon, 27 Oct 2014 20:51:48 +0100 From: Nicholas Mc Guire To: Randy Dunlap , Michal Marek Cc: Christoph Hellwig , Joe Perches , LKML Subject: [PATCH 1/4 v2] mandate defined build cmd and source ref for _shipped files Message-ID: <20141027195148.GB10079@opentech.at> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.18 (2008-05-17) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org mandate defined build cmd and source ref for _shipped files Currently shipped files have more or less free style indications of how to generate them respectively what the sources are, in their header. Mandating defined tags and keywords would allow for automated checking. This patch is against 3.18.0-rc1 Signed-off-by: Nicholas Mc Guire --- Documentation/CodingStyle | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 3171822..48b9048 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -845,6 +845,24 @@ next instruction in the assembly output: : /* outputs */ : /* inputs */ : /* clobbers */); + Chapter 20: Generated files + +For files generated by special purpose tools/scripts that +justify providing _shipped files the header of the generated +file needs indicate that it was generated, how to generate +the file and its source location. + +/* Do not edit this file! It was automatically generated by */ +/* generator: command options arguments */ +/* sources: path/to/sources/filename */ + +Example: + +/* Do not edit this file! It was automatically generated by */ +/* generator: loadkeys --mktable defkeymap.map > defkeymap.c */ +/* sources: drivers/tty/vt/defkeymap.map */ + + Appendix I: References -- 1.7.10.4