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.h...@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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
