public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Nicholas Mc Guire <der.herr@hofr.at>
To: Randy Dunlap <rdunlap@infradead.org>, Michal Marek <mmarek@suse.cz>
Cc: Christoph Hellwig <hch@infradead.org>,
	Joe Perches <joe@perches.com>,
	LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH 3/3] mandate defined build commmand and source for _shipped files
Date: Wed, 1 Oct 2014 15:38:09 +0200	[thread overview]
Message-ID: <20141001133809.GD5560@opentech.at> (raw)


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 <der.herr@hofr.at>
---
 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


                 reply	other threads:[~2014-10-01 13:38 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20141001133809.GD5560@opentech.at \
    --to=der.herr@hofr.at \
    --cc=hch@infradead.org \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mmarek@suse.cz \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox