From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751712AbaJANiL (ORCPT ); Wed, 1 Oct 2014 09:38:11 -0400 Received: from hofr.at ([212.69.189.236]:47558 "EHLO mail.hofr.at" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751343AbaJANiK (ORCPT ); Wed, 1 Oct 2014 09:38:10 -0400 Date: Wed, 1 Oct 2014 15:38:09 +0200 From: Nicholas Mc Guire To: Randy Dunlap , Michal Marek Cc: Christoph Hellwig , Joe Perches , LKML Subject: [PATCH 3/3] mandate defined build commmand and source for _shipped files Message-ID: <20141001133809.GD5560@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 commmand and source 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.17.0-rt6 Signed-off-by: Der Herr Hofrat --- Documentation/CodingStyle | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 6b6bef3..50295f8 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -844,6 +844,22 @@ next instruction in the assembly output: "more_magic %reg2, %reg3" : /* 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