Commit 59e55019 authored by Roman Zippel's avatar Roman Zippel Committed by Ben Collins

[PATCH] update kconfig documentation

Fix various typos and and information about the new kconfig features.
parent b4346ab0
...@@ -18,7 +18,7 @@ organized in a tree structure: ...@@ -18,7 +18,7 @@ organized in a tree structure:
+- ... +- ...
Every entry has its own dependencies. These dependencies are used Every entry has its own dependencies. These dependencies are used
to determine the visible of an entry. Any child entry is only to determine the visibility of an entry. Any child entry is only
visible if its parent entry is also visible. visible if its parent entry is also visible.
Menu entries Menu entries
...@@ -50,7 +50,7 @@ applicable everywhere (see syntax). ...@@ -50,7 +50,7 @@ applicable everywhere (see syntax).
- type definition: "bool"/"tristate"/"string"/"hex"/"integer" - type definition: "bool"/"tristate"/"string"/"hex"/"integer"
Every config option must have a type. There are only two basic types: Every config option must have a type. There are only two basic types:
tristate and string, the other types base on these two. The type tristate and string, the other types are based on these two. The type
definition optionally accepts an input prompt, so these two examples definition optionally accepts an input prompt, so these two examples
are equivalent: are equivalent:
...@@ -64,7 +64,7 @@ applicable everywhere (see syntax). ...@@ -64,7 +64,7 @@ applicable everywhere (see syntax).
to the user. Optionally dependencies only for this prompt can be added to the user. Optionally dependencies only for this prompt can be added
with "if". with "if".
- default value: "default" <symbol> ["if" <expr>] - default value: "default" <expr> ["if" <expr>]
A config option can have any number of default values. If multiple A config option can have any number of default values. If multiple
default values are visible, only the first defined one is active. default values are visible, only the first defined one is active.
Default values are not limited to the menu entry, where they are Default values are not limited to the menu entry, where they are
...@@ -81,7 +81,7 @@ applicable everywhere (see syntax). ...@@ -81,7 +81,7 @@ applicable everywhere (see syntax).
This defines a dependency for this menu entry. If multiple This defines a dependency for this menu entry. If multiple
dependencies are defined they are connected with '&&'. Dependencies dependencies are defined they are connected with '&&'. Dependencies
are applied to all other options within this menu entry (which also are applied to all other options within this menu entry (which also
accept "if" expression), so these two examples are equivalent: accept an "if" expression), so these two examples are equivalent:
bool "foo" if BAR bool "foo" if BAR
default y if BAR default y if BAR
...@@ -90,9 +90,24 @@ applicable everywhere (see syntax). ...@@ -90,9 +90,24 @@ applicable everywhere (see syntax).
bool "foo" bool "foo"
default y default y
- reverse dependencies: "select" <symbol> ["if" <expr>]
While normal dependencies reduce the upper limit of a symbol (see
below), reverse dependencies can be used to force a lower limit of
another symbol. The value of the current menu symbol is used as the
minimal value <symbol> can be set to. If <symbol> is selected multiple
times, the limit is set to the largest selection.
Reverse dependencies can only be used with boolean or tristate
symbols.
- numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
This allows to limit the range of possible input values for integer
and hex symbols. The user can only input a value which is larger than
or equal to the first symbol and smaller than or equal to the second
symbol.
- help text: "help" - help text: "help"
This defines a help text. The end of the help text is determined by This defines a help text. The end of the help text is determined by
the level indentation, this means it ends at the first line which has the indentation level, this means it ends at the first line which has
a smaller indentation than the first line of the help text. a smaller indentation than the first line of the help text.
...@@ -123,14 +138,14 @@ Expressions are listed in decreasing order of precedence. ...@@ -123,14 +138,14 @@ Expressions are listed in decreasing order of precedence.
otherwise 'y'. otherwise 'y'.
(4) Returns the value of the expression. Used to override precedence. (4) Returns the value of the expression. Used to override precedence.
(5) Returns the result of (2-/expr/). (5) Returns the result of (2-/expr/).
(6) Returns the result of min(/expr/, /expr/). (6) Returns the result of max(/expr/, /expr/).
(7) Returns the result of max(/expr/, /expr/). (7) Returns the result of min(/expr/, /expr/).
An expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2 An expression can have a value of 'n', 'm' or 'y' (or 0, 1, 2
respectively for calculations). A menu entry becomes visible when it's respectively for calculations). A menu entry becomes visible when it's
expression evaluates to 'm' or 'y'. expression evaluates to 'm' or 'y'.
There are two type of symbols: constant and nonconstant symbols. There are two types of symbols: constant and nonconstant symbols.
Nonconstant symbols are the most common ones and are defined with the Nonconstant symbols are the most common ones and are defined with the
'config' statement. Nonconstant symbols consist entirely of alphanumeric 'config' statement. Nonconstant symbols consist entirely of alphanumeric
characters or underscores. characters or underscores.
...@@ -159,8 +174,8 @@ dependency list of the config option NETDEVICES. ...@@ -159,8 +174,8 @@ dependency list of the config option NETDEVICES.
The other way to generate the menu structure is done by analyzing the The other way to generate the menu structure is done by analyzing the
dependencies. If a menu entry somehow depends on the previous entry, it dependencies. If a menu entry somehow depends on the previous entry, it
can be made a submenu of it. First the the previous (parent) symbol must can be made a submenu of it. First, the previous (parent) symbol must
be part of the dependency list and then one of these two condititions be part of the dependency list and then one of these two conditions
must be true: must be true:
- the child entry must become invisible, if the parent is set to 'n' - the child entry must become invisible, if the parent is set to 'n'
- the child entry must only be visible, if the parent is visible - the child entry must only be visible, if the parent is visible
...@@ -177,7 +192,7 @@ comment "module support disabled" ...@@ -177,7 +192,7 @@ comment "module support disabled"
MODVERSIONS directly depends on MODULES, this means it's only visible if 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 MODULES is different from 'n'. The comment on the other hand is always
visible when MODULES it's visible (the (empty) dependency of MODULES is visible when MODULES is visible (the (empty) dependency of MODULES is
also part of the comment dependencies). also part of the comment dependencies).
...@@ -188,12 +203,13 @@ The configuration file describes a series of menu entries, where every ...@@ -188,12 +203,13 @@ The configuration file describes a series of menu entries, where every
line starts with a keyword (except help texts). The following keywords line starts with a keyword (except help texts). The following keywords
end a menu entry: end a menu entry:
- config - config
- menuconfig
- choice/endchoice - choice/endchoice
- comment - comment
- menu/endmenu - menu/endmenu
- if/endif - if/endif
- source - source
The first four also start the definition of a menu entry. The first five also start the definition of a menu entry.
config: config:
...@@ -203,6 +219,14 @@ config: ...@@ -203,6 +219,14 @@ config:
This defines a config symbol <symbol> and accepts any of above This defines a config symbol <symbol> and accepts any of above
attributes as options. attributes as options.
menuconfig:
"menuconfig" <symbol>
<config options>
This is similiar to the simple config entry above, but it also gives a
hint to front ends, that all suboptions should be displayed as a
separate list of options.
choices: choices:
"choice" "choice"
......
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