Commit:     4e7bd66318b3ae60fbba7d886d9a98b71ffbf74e
Parent:     a923fd6ae7599aee63934ed13c3033fdefc7a18e
Author:     Josh Triplett <[EMAIL PROTECTED]>
AuthorDate: Sun Jul 15 23:41:37 2007 -0700
Committer:  Linus Torvalds <[EMAIL PROTECTED]>
CommitDate: Mon Jul 16 09:05:50 2007 -0700

    CodingStyle: add information about editor modelines
    I recently received a patch including a file that had a vim modeline,
    and I realized that nothing specifically proscribed that practice.
    Signed-off-by: Josh Triplett <[EMAIL PROTECTED]>
    Signed-off-by: Andrew Morton <[EMAIL PROTECTED]>
    Signed-off-by: Linus Torvalds <[EMAIL PROTECTED]>
 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"
+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
To unsubscribe from this list: send the line "unsubscribe git-commits-head" in
the body of a message to [EMAIL PROTECTED]
More majordomo info at

Reply via email to