Merge git://git.kernel.org/pub/scm/linux/kernel/git/sfrench/cifs-2.6

[linux-2.6] / Documentation / kbuild / kconfig-language.txt

diff --git a/Documentation/kbuild/kconfig-language.txt b/Documentation/kbuild/kconfig-language.txt
index 125093c3ef76229296c171167c726c32d8e82b1a..616043a6da99a0afd945e3cb5acb93b26bbb3f17 100644 (file)
--- a/Documentation/kbuild/kconfig-language.txt
+++ b/Documentation/kbuild/kconfig-language.txt
@@ -29,7 +29,7 @@ them. A single configuration option is defined like this:
 
 config MODVERSIONS
        bool "Set version information on all module symbols"
 
 config MODVERSIONS
        bool "Set version information on all module symbols"

-       depends MODULES
+       depends on MODULES

        help
          Usually, modules have to be recompiled whenever you switch to a new
          kernel.  ...
        help
          Usually, modules have to be recompiled whenever you switch to a new
          kernel.  ...


@@ -77,7 +77,12 @@ applicable everywhere (see syntax).
   Optionally, dependencies only for this default value can be added with
   "if".
 
   Optionally, dependencies only for this default value can be added with
   "if".
 

-- dependencies: "depends on"/"requires" <expr>
+- type definition + default value:
+       "def_bool"/"def_tristate" <expr> ["if" <expr>]
+  This is a shorthand notation for a type definition plus a value.
+  Optionally dependencies for this default value can be added with "if".
+
+- dependencies: "depends on" <expr>

   This defines a dependency for this menu entry. If multiple
   dependencies are defined, they are connected with '&&'. Dependencies
   are applied to all other options within this menu entry (which also
   This defines a dependency for this menu entry. If multiple
   dependencies are defined, they are connected with '&&'. Dependencies
   are applied to all other options within this menu entry (which also


@@ -98,6 +103,15 @@ applicable everywhere (see syntax).
   times, the limit is set to the largest selection.
   Reverse dependencies can only be used with boolean or tristate
   symbols.
   times, the limit is set to the largest selection.
   Reverse dependencies can only be used with boolean or tristate
   symbols.

+  Note:
+       select is evil.... select will by brute force set a symbol
+       equal to 'y' without visiting the dependencies. So abusing
+       select you are able to select a symbol FOO even if FOO depends
+       on BAR that is not set. In general use select only for
+       non-visible symbols (no promts anywhere) and for symbols with
+       no dependencies. That will limit the usefulness but on the
+       other hand avoid the illegal configurations all over. kconfig
+       should one day warn about such things.

 
 - numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
   This allows to limit the range of possible input values for int
 
 - numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
   This allows to limit the range of possible input values for int


@@ -163,7 +177,7 @@ The position of a menu entry in the tree is determined in two ways. First
 it can be specified explicitly:
 
 menu "Network device support"
 it can be specified explicitly:
 
 menu "Network device support"

-       depends NET
+       depends on NET

 
 config NETDEVICES
        ...
 
 config NETDEVICES
        ...


@@ -188,10 +202,10 @@ config MODULES
 
 config MODVERSIONS
        bool "Set version information on all module symbols"
 
 config MODVERSIONS
        bool "Set version information on all module symbols"

-       depends MODULES
+       depends on MODULES

 
 comment "module support disabled"
 
 comment "module support disabled"

-       depends !MODULES
+       depends on !MODULES

 
 MODVERSIONS directly depends on MODULES, this means it's only visible if
 MODULES is different from 'n'. The comment on the other hand is always
 
 MODVERSIONS directly depends on MODULES, this means it's only visible if
 MODULES is different from 'n'. The comment on the other hand is always


@@ -280,3 +294,10 @@ source:
        "source" <prompt>
 
 This reads the specified configuration file. This file is always parsed.
        "source" <prompt>
 
 This reads the specified configuration file. This file is always parsed.

+
+mainmenu:
+
+       "mainmenu" <prompt>
+
+This sets the config program's title bar if the config program chooses
+to use it.