Commit 6754bb4d authored by Robert P. J. Day's avatar Robert P. J. Day Committed by Linus Torvalds

Documentation: fix the explanation of Kconfig files

Fix the obvious errors in the explanation of Kconfig files.
Signed-off-by: default avatarRobert P. J. Day <rpjday@mindspring.com>
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 9aaffc89
...@@ -495,29 +495,40 @@ re-formatting you may want to take a look at the man page. But ...@@ -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
Apply nitroglycerine inside the keyboard (DANGEROUS)
bool CONFIG_CHEER
depends on CONFIG_BOOM
default y
help help
Output nice messages when you explode Enable auditing infrastructure that can be used with another
endif 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
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
...
Generally, CONFIG_EXPERIMENTAL should surround all options not considered For full documentation on the configuration files, see the file
stable. All options that are known to trash data (experimental write- Documentation/kbuild/kconfig-language.txt.
support for file-systems, for instance) should be denoted (DANGEROUS), other
experimental options should be denoted (EXPERIMENTAL).
Chapter 11: Data structures Chapter 11: Data structures
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment