Messages in this thread Patch in this message | | | Subject | [PATCH] CodingStyle: Add information about editor modelines | From | Josh Triplett <> | Date | Wed, 27 Jun 2007 11:00:46 -0700 |
| |
Signed-off-by: Josh Triplett <josh@freedesktop.org> --- I recently received a patch including a file that had a vim modeline, and I realized that nothing specifically proscribed that practice.
Documentation/CodingStyle | 27 +++++++++++++++++++++++++++ 1 files changed, 27 insertions(+), 0 deletions(-)
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 00bffa7..a667eb1 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -738,6 +738,33 @@ need them. Feel free to peruse that header file to see what else is already defined that you shouldn't reproduce in your code.
+ Chapter 18: Editor modelines and other cruft + +Some editors can interpret configuration information embedded in source files, +indicated with special markers. For example, emacs interprets lines marked +like this: + +-*- mode: c -*- + +Or like this: + +/* +Local Variables: +compile-command: "gcc -DMAGIC_DEBUG_FLAG foo.c" +End: +*/ + +Vim interprets markers that look like this: + +/* vim:set sw=8 noet */ + +Do not include any of these in source files. People have their own personal +editor configurations, and your source files should not override them. This +includes markers for indentation and mode configuration. People may use their +own custom mode, or may have some other magic method for making indentation +work correctly. + + Appendix I: References -- 1.5.2.1
- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |