dect
/
linux-2.6
Archived
13
0
Fork 0
Code Releases Activity

Documentation: fix the explanation of Kconfig files 

Fix the obvious errors in the explanation of Kconfig files.

Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Robert P. J. Day 2007-05-23 13:57:42 -07:00 committed by Linus Torvalds
parent 9aaffc898f
commit 6754bb4de9
1 changed files with 30 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Documentation/CodingStyle
View File

@ -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. 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), For all of the Kconfig* configuration files throughout the source tree,
somewhat different indentation is used. 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. config AUDIT
bool "Auditing support"
if CONFIG_EXPERIMENTAL depends on NET
tristate CONFIG_BOOM
default n
help help
Apply nitroglycerine inside the keyboard (DANGEROUS) Enable auditing infrastructure that can be used with another
bool CONFIG_CHEER kernel subsystem, such as SELinux (which requires this for
depends on CONFIG_BOOM logging of avc messages output). Does not do system-call
default y auditing without CONFIG_AUDITSYSCALL.
help
Output nice messages when you explode
endif
Generally, CONFIG_EXPERIMENTAL should surround all options not considered Features that might still be considered unstable should be defined as
stable. All options that are known to trash data (experimental write- dependent on "EXPERIMENTAL":
support for file-systems, for instance) should be denoted (DANGEROUS), other
experimental options should be denoted (EXPERIMENTAL). config SLUB
depends on EXPERIMENTAL && !ARCH_USES_SLAB_PAGE_STRUCT
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
...
For full documentation on the configuration files, see the file
Documentation/kbuild/kconfig-language.txt.
Chapter 11: Data structures Chapter 11: Data structures