Commit:     6754bb4de94098a0aaa23a600f0edb9a9454c252
Parent:     9aaffc898ff4a3df18c5fc4b9e0fa47e779ad726
Author:     Robert P. J. Day <[EMAIL PROTECTED]>
AuthorDate: Wed May 23 13:57:42 2007 -0700
Committer:  Linus Torvalds <[EMAIL PROTECTED]>
CommitDate: Wed May 23 20:14:12 2007 -0700

    Documentation: fix the explanation of Kconfig files
    Fix the obvious errors in the explanation of Kconfig files.
    Signed-off-by: Robert P. J. Day <[EMAIL PROTECTED]>
    Signed-off-by: Randy Dunlap <[EMAIL PROTECTED]>
    Signed-off-by: Andrew Morton <[EMAIL PROTECTED]>
    Signed-off-by: Linus Torvalds <[EMAIL PROTECTED]>
 Documentation/CodingStyle |   49 +++++++++++++++++++++++++++-----------------
 1 files changed, 30 insertions(+), 19 deletions(-)

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index afc2867..b49b92e 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -495,29 +495,40 @@ re-formatting you may want to take a look at the man 
page.  But
 remember: "indent" is not a fix for bad programming.
-               Chapter 10: Configuration-files
+               Chapter 10: Kconfig configuration files
-For configuration options (arch/xxx/Kconfig, and all the Kconfig files),
-somewhat different indentation is used.
+For all of the Kconfig* configuration files throughout the source tree,
+the indentation is somewhat different.  Lines under a "config" definition
+are indented with one tab, while help text is indented an additional two
+spaces.  Example:
-Help text is indented with 2 spaces.
-       tristate CONFIG_BOOM
-       default n
-       help
-         Apply nitroglycerine inside the keyboard (DANGEROUS)
-       bool CONFIG_CHEER
-       depends on CONFIG_BOOM
-       default y
+config AUDIT
+       bool "Auditing support"
+       depends on NET
-         Output nice messages when you explode
+         Enable auditing infrastructure that can be used with another
+         kernel subsystem, such as SELinux (which requires this for
+         logging of avc messages output).  Does not do system-call
+         auditing without CONFIG_AUDITSYSCALL.
+Features that might still be considered unstable should be defined as
+dependent on "EXPERIMENTAL":
+config SLUB
+       bool "SLUB (Unqueued Allocator)"
+       ...
+while seriously dangerous features (such as write support for certain
+filesystems) should advertise this prominently in their prompt string:
+config ADFS_FS_RW
+       bool "ADFS write support (DANGEROUS)"
+       depends on ADFS_FS
+       ...
-Generally, CONFIG_EXPERIMENTAL should surround all options not considered
-stable. All options that are known to trash data (experimental write-
-support for file-systems, for instance) should be denoted (DANGEROUS), other
-experimental options should be denoted (EXPERIMENTAL).
+For full documentation on the configuration files, see the file
                Chapter 11: Data structures
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