Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Robert P. J. Day and committed by
Linus Torvalds
6754bb4d 9aaffc89

+30 -19
+30 -19
Documentation/CodingStyle
··· 495 495 remember: "indent" is not a fix for bad programming. 496 496 497 497 498 - Chapter 10: Configuration-files 498 + Chapter 10: Kconfig configuration files 499 499 500 - For configuration options (arch/xxx/Kconfig, and all the Kconfig files), 501 - somewhat different indentation is used. 500 + For all of the Kconfig* configuration files throughout the source tree, 501 + the indentation is somewhat different. Lines under a "config" definition 502 + are indented with one tab, while help text is indented an additional two 503 + spaces. Example: 502 504 503 - Help text is indented with 2 spaces. 504 - 505 - if CONFIG_EXPERIMENTAL 506 - tristate CONFIG_BOOM 507 - default n 505 + config AUDIT 506 + bool "Auditing support" 507 + depends on NET 508 508 help 509 - Apply nitroglycerine inside the keyboard (DANGEROUS) 510 - bool CONFIG_CHEER 511 - depends on CONFIG_BOOM 512 - default y 513 - help 514 - Output nice messages when you explode 515 - endif 509 + Enable auditing infrastructure that can be used with another 510 + kernel subsystem, such as SELinux (which requires this for 511 + logging of avc messages output). Does not do system-call 512 + auditing without CONFIG_AUDITSYSCALL. 516 513 517 - Generally, CONFIG_EXPERIMENTAL should surround all options not considered 518 - stable. All options that are known to trash data (experimental write- 519 - support for file-systems, for instance) should be denoted (DANGEROUS), other 520 - experimental options should be denoted (EXPERIMENTAL). 514 + Features that might still be considered unstable should be defined as 515 + dependent on "EXPERIMENTAL": 516 + 517 + config SLUB 518 + depends on EXPERIMENTAL && !ARCH_USES_SLAB_PAGE_STRUCT 519 + bool "SLUB (Unqueued Allocator)" 520 + ... 521 + 522 + while seriously dangerous features (such as write support for certain 523 + filesystems) should advertise this prominently in their prompt string: 524 + 525 + config ADFS_FS_RW 526 + bool "ADFS write support (DANGEROUS)" 527 + depends on ADFS_FS 528 + ... 529 + 530 + For full documentation on the configuration files, see the file 531 + Documentation/kbuild/kconfig-language.txt. 521 532 522 533 523 534 Chapter 11: Data structures