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

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>

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