aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/CodingStyle
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/CodingStyle')
-rw-r--r--Documentation/CodingStyle27
1 files changed, 27 insertions, 0 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 00bffa7b740e..a667eb1fc26e 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
738defined that you shouldn't reproduce in your code. 738defined that you shouldn't reproduce in your code.
739 739
740 740
741 Chapter 18: Editor modelines and other cruft
742
743Some editors can interpret configuration information embedded in source files,
744indicated with special markers. For example, emacs interprets lines marked
745like this:
746
747-*- mode: c -*-
748
749Or like this:
750
751/*
752Local Variables:
753compile-command: "gcc -DMAGIC_DEBUG_FLAG foo.c"
754End:
755*/
756
757Vim interprets markers that look like this:
758
759/* vim:set sw=8 noet */
760
761Do not include any of these in source files. People have their own personal
762editor configurations, and your source files should not override them. This
763includes markers for indentation and mode configuration. People may use their
764own custom mode, or may have some other magic method for making indentation
765work correctly.
766
767
741 768
742 Appendix I: References 769 Appendix I: References
743 770