aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-07-09 12:25:51 -0400
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>2019-07-15 10:03:04 -0400
commit168869492e7009b6861b615f1d030c99bc805e83 (patch)
tree33d78d1d408f4fb15da100337f4de472826fff9f
parent8bb0776b8b27d548c7e65828ec3a02cb31fe3eed (diff)
docs: kbuild: fix build with pdf and fix some minor issues
The tag ".. include" should be replaced by ".. literalinclude" at issues.rst, otherwise it causes TeX to crash due to excessive usage of stack with Sphinx 2.0. While here, solve a few minor issues at the kbuild book output by adding extra blank lines. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
-rw-r--r--Documentation/kbuild/issues.rst20
-rw-r--r--Documentation/kbuild/kbuild.rst3
-rw-r--r--Documentation/kbuild/kconfig-language.rst12
-rw-r--r--Documentation/kbuild/kconfig.rst8
-rw-r--r--Documentation/kbuild/makefiles.rst1
5 files changed, 33 insertions, 11 deletions
diff --git a/Documentation/kbuild/issues.rst b/Documentation/kbuild/issues.rst
index 9fdded4b681c..bdab01f733f6 100644
--- a/Documentation/kbuild/issues.rst
+++ b/Documentation/kbuild/issues.rst
@@ -1,11 +1,15 @@
1Recursion issue #1 1================
2------------------ 2Recursion issues
3================
3 4
4 .. include:: Kconfig.recursion-issue-01 5issue #1
5 :literal: 6--------
6 7
7Recursion issue #2 8.. literalinclude:: Kconfig.recursion-issue-01
8------------------ 9 :language: kconfig
9 10
10 .. include:: Kconfig.recursion-issue-02 11issue #2
11 :literal: 12--------
13
14.. literalinclude:: Kconfig.recursion-issue-02
15 :language: kconfig
diff --git a/Documentation/kbuild/kbuild.rst b/Documentation/kbuild/kbuild.rst
index b25548963d70..ce9b99c004ae 100644
--- a/Documentation/kbuild/kbuild.rst
+++ b/Documentation/kbuild/kbuild.rst
@@ -18,7 +18,7 @@ This file lists all modules that are built into the kernel. This is used
18by modprobe to not fail when trying to load something builtin. 18by modprobe to not fail when trying to load something builtin.
19 19
20modules.builtin.modinfo 20modules.builtin.modinfo
21-------------------------------------------------- 21-----------------------
22This file contains modinfo from all modules that are built into the kernel. 22This file contains modinfo from all modules that are built into the kernel.
23Unlike modinfo of a separate module, all fields are prefixed with module name. 23Unlike modinfo of a separate module, all fields are prefixed with module name.
24 24
@@ -153,6 +153,7 @@ Install script called when using "make install".
153The default name is "installkernel". 153The default name is "installkernel".
154 154
155The script will be called with the following arguments: 155The script will be called with the following arguments:
156
156 - $1 - kernel version 157 - $1 - kernel version
157 - $2 - kernel image file 158 - $2 - kernel image file
158 - $3 - kernel map file 159 - $3 - kernel map file
diff --git a/Documentation/kbuild/kconfig-language.rst b/Documentation/kbuild/kconfig-language.rst
index 2bc8a7803365..74bef19f69f0 100644
--- a/Documentation/kbuild/kconfig-language.rst
+++ b/Documentation/kbuild/kconfig-language.rst
@@ -53,6 +53,7 @@ A menu entry can have a number of attributes. Not all of them are
53applicable everywhere (see syntax). 53applicable everywhere (see syntax).
54 54
55- type definition: "bool"/"tristate"/"string"/"hex"/"int" 55- type definition: "bool"/"tristate"/"string"/"hex"/"int"
56
56 Every config option must have a type. There are only two basic types: 57 Every config option must have a type. There are only two basic types:
57 tristate and string; the other types are based on these two. The type 58 tristate and string; the other types are based on these two. The type
58 definition optionally accepts an input prompt, so these two examples 59 definition optionally accepts an input prompt, so these two examples
@@ -66,11 +67,13 @@ applicable everywhere (see syntax).
66 prompt "Networking support" 67 prompt "Networking support"
67 68
68- input prompt: "prompt" <prompt> ["if" <expr>] 69- input prompt: "prompt" <prompt> ["if" <expr>]
70
69 Every menu entry can have at most one prompt, which is used to display 71 Every menu entry can have at most one prompt, which is used to display
70 to the user. Optionally dependencies only for this prompt can be added 72 to the user. Optionally dependencies only for this prompt can be added
71 with "if". 73 with "if".
72 74
73- default value: "default" <expr> ["if" <expr>] 75- default value: "default" <expr> ["if" <expr>]
76
74 A config option can have any number of default values. If multiple 77 A config option can have any number of default values. If multiple
75 default values are visible, only the first defined one is active. 78 default values are visible, only the first defined one is active.
76 Default values are not limited to the menu entry where they are 79 Default values are not limited to the menu entry where they are
@@ -112,6 +115,7 @@ applicable everywhere (see syntax).
112 Optionally dependencies for this default value can be added with "if". 115 Optionally dependencies for this default value can be added with "if".
113 116
114- dependencies: "depends on" <expr> 117- dependencies: "depends on" <expr>
118
115 This defines a dependency for this menu entry. If multiple 119 This defines a dependency for this menu entry. If multiple
116 dependencies are defined, they are connected with '&&'. Dependencies 120 dependencies are defined, they are connected with '&&'. Dependencies
117 are applied to all other options within this menu entry (which also 121 are applied to all other options within this menu entry (which also
@@ -127,6 +131,7 @@ applicable everywhere (see syntax).
127 default y 131 default y
128 132
129- reverse dependencies: "select" <symbol> ["if" <expr>] 133- reverse dependencies: "select" <symbol> ["if" <expr>]
134
130 While normal dependencies reduce the upper limit of a symbol (see 135 While normal dependencies reduce the upper limit of a symbol (see
131 below), reverse dependencies can be used to force a lower limit of 136 below), reverse dependencies can be used to force a lower limit of
132 another symbol. The value of the current menu symbol is used as the 137 another symbol. The value of the current menu symbol is used as the
@@ -146,6 +151,7 @@ applicable everywhere (see syntax).
146 the illegal configurations all over. 151 the illegal configurations all over.
147 152
148- weak reverse dependencies: "imply" <symbol> ["if" <expr>] 153- weak reverse dependencies: "imply" <symbol> ["if" <expr>]
154
149 This is similar to "select" as it enforces a lower limit on another 155 This is similar to "select" as it enforces a lower limit on another
150 symbol except that the "implied" symbol's value may still be set to n 156 symbol except that the "implied" symbol's value may still be set to n
151 from a direct dependency or with a visible prompt. 157 from a direct dependency or with a visible prompt.
@@ -176,6 +182,7 @@ applicable everywhere (see syntax).
176 configure that subsystem out without also having to unset these drivers. 182 configure that subsystem out without also having to unset these drivers.
177 183
178- limiting menu display: "visible if" <expr> 184- limiting menu display: "visible if" <expr>
185
179 This attribute is only applicable to menu blocks, if the condition is 186 This attribute is only applicable to menu blocks, if the condition is
180 false, the menu block is not displayed to the user (the symbols 187 false, the menu block is not displayed to the user (the symbols
181 contained there can still be selected by other symbols, though). It is 188 contained there can still be selected by other symbols, though). It is
@@ -183,12 +190,14 @@ applicable everywhere (see syntax).
183 entries. Default value of "visible" is true. 190 entries. Default value of "visible" is true.
184 191
185- numerical ranges: "range" <symbol> <symbol> ["if" <expr>] 192- numerical ranges: "range" <symbol> <symbol> ["if" <expr>]
193
186 This allows to limit the range of possible input values for int 194 This allows to limit the range of possible input values for int
187 and hex symbols. The user can only input a value which is larger than 195 and hex symbols. The user can only input a value which is larger than
188 or equal to the first symbol and smaller than or equal to the second 196 or equal to the first symbol and smaller than or equal to the second
189 symbol. 197 symbol.
190 198
191- help text: "help" or "---help---" 199- help text: "help" or "---help---"
200
192 This defines a help text. The end of the help text is determined by 201 This defines a help text. The end of the help text is determined by
193 the indentation level, this means it ends at the first line which has 202 the indentation level, this means it ends at the first line which has
194 a smaller indentation than the first line of the help text. 203 a smaller indentation than the first line of the help text.
@@ -197,6 +206,7 @@ applicable everywhere (see syntax).
197 the file as an aid to developers. 206 the file as an aid to developers.
198 207
199- misc options: "option" <symbol>[=<value>] 208- misc options: "option" <symbol>[=<value>]
209
200 Various less common options can be defined via this option syntax, 210 Various less common options can be defined via this option syntax,
201 which can modify the behaviour of the menu entry and its config 211 which can modify the behaviour of the menu entry and its config
202 symbol. These options are currently possible: 212 symbol. These options are currently possible:
@@ -325,6 +335,7 @@ end a menu entry:
325The first five also start the definition of a menu entry. 335The first five also start the definition of a menu entry.
326 336
327config:: 337config::
338
328 "config" <symbol> 339 "config" <symbol>
329 <config options> 340 <config options>
330 341
@@ -332,6 +343,7 @@ This defines a config symbol <symbol> and accepts any of above
332attributes as options. 343attributes as options.
333 344
334menuconfig:: 345menuconfig::
346
335 "menuconfig" <symbol> 347 "menuconfig" <symbol>
336 <config options> 348 <config options>
337 349
diff --git a/Documentation/kbuild/kconfig.rst b/Documentation/kbuild/kconfig.rst
index 88129af7e539..a9a855f894b3 100644
--- a/Documentation/kbuild/kconfig.rst
+++ b/Documentation/kbuild/kconfig.rst
@@ -264,6 +264,7 @@ NCONFIG_MODE
264This mode shows all sub-menus in one large tree. 264This mode shows all sub-menus in one large tree.
265 265
266Example:: 266Example::
267
267 make NCONFIG_MODE=single_menu nconfig 268 make NCONFIG_MODE=single_menu nconfig
268 269
269---------------------------------------------------------------------- 270----------------------------------------------------------------------
@@ -277,9 +278,12 @@ Searching in xconfig:
277 names, so you have to know something close to what you are 278 names, so you have to know something close to what you are
278 looking for. 279 looking for.
279 280
280 Example: 281 Example::
282
281 Ctrl-F hotplug 283 Ctrl-F hotplug
282 or 284
285 or::
286
283 Menu: File, Search, hotplug 287 Menu: File, Search, hotplug
284 288
285 lists all config symbol entries that contain "hotplug" in 289 lists all config symbol entries that contain "hotplug" in
diff --git a/Documentation/kbuild/makefiles.rst b/Documentation/kbuild/makefiles.rst
index 093f2d79ab95..f31158457753 100644
--- a/Documentation/kbuild/makefiles.rst
+++ b/Documentation/kbuild/makefiles.rst
@@ -384,6 +384,7 @@ more details, with real examples.
384----------------------- 384-----------------------
385 385
386 Kbuild tracks dependencies on the following: 386 Kbuild tracks dependencies on the following:
387
387 1) All prerequisite files (both `*.c` and `*.h`) 388 1) All prerequisite files (both `*.c` and `*.h`)
388 2) `CONFIG_` options used in all prerequisite files 389 2) `CONFIG_` options used in all prerequisite files
389 3) Command-line used to compile target 390 3) Command-line used to compile target