linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/4 v2] mandate defined build cmd and source ref for _shipped files
@ 2014-10-27 19:51 Nicholas Mc Guire
  0 siblings, 0 replies; only message in thread
From: Nicholas Mc Guire @ 2014-10-27 19:51 UTC (permalink / raw)
  To: Randy Dunlap, Michal Marek; +Cc: Christoph Hellwig, Joe Perches, LKML


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


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2014-10-27 19:51 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-10-27 19:51 [PATCH 1/4 v2] mandate defined build cmd and source ref for _shipped files Nicholas Mc Guire

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).