diff options
| -rw-r--r-- | Documentation/CodingStyle | 49 |
1 files changed, 30 insertions, 19 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index afc286775891..b49b92edb396 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 | |||
| 495 | remember: "indent" is not a fix for bad programming. | 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), | 500 | For all of the Kconfig* configuration files throughout the source tree, |
| 501 | somewhat different indentation is used. | 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. | 505 | config AUDIT |
| 504 | 506 | bool "Auditing support" | |
| 505 | if CONFIG_EXPERIMENTAL | 507 | depends on NET |
| 506 | tristate CONFIG_BOOM | ||
| 507 | default n | ||
| 508 | help | ||
| 509 | Apply nitroglycerine inside the keyboard (DANGEROUS) | ||
| 510 | bool CONFIG_CHEER | ||
| 511 | depends on CONFIG_BOOM | ||
| 512 | default y | ||
| 513 | help | 508 | help |
| 514 | Output nice messages when you explode | 509 | Enable auditing infrastructure that can be used with another |
| 515 | endif | 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. | ||
| 513 | |||
| 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 | ... | ||
| 516 | 529 | ||
| 517 | Generally, CONFIG_EXPERIMENTAL should surround all options not considered | 530 | For full documentation on the configuration files, see the file |
| 518 | stable. All options that are known to trash data (experimental write- | 531 | Documentation/kbuild/kconfig-language.txt. |
| 519 | support for file-systems, for instance) should be denoted (DANGEROUS), other | ||
| 520 | experimental options should be denoted (EXPERIMENTAL). | ||
| 521 | 532 | ||
| 522 | 533 | ||
| 523 | Chapter 11: Data structures | 534 | Chapter 11: Data structures |
