mandate defined build cmd and source ref for _shipped files
PATCH v2 1/4 mandate defined build cmd and source ref for _shipped files
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 <[email protected]>
--- Documentation/CodingStyle | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+)
Documentation/CodingStyle +18 -0
@@ -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
Signature · 1 line
1.7.10.4