Kernel/linux-next
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git synced 2025-01-01 10:42:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: kbuild: convert docs to ReST and rename to *.rst

Browse Source 
The kbuild documentation clearly shows that the documents
there are written at different times: some use markdown,
some use their own peculiar logic to split sections.

Convert everything to ReST without affecting too much
the author's style and avoiding adding uneeded markups.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2019-06-12 14:52:48 -03:00 committed by Jonathan Corbet
parent d7b461c5e8
commit cd238effef
48 changed files with 840 additions and 561 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/admin-guide/README.rst
View File

@ -227,7 +227,7 @@ Configuring the kernel
"make tinyconfig" Configure the tiniest possible kernel. "make tinyconfig" Configure the tiniest possible kernel.
You can find more information on using the Linux kernel config tools You can find more information on using the Linux kernel config tools
in Documentation/kbuild/kconfig.txt. in Documentation/kbuild/kconfig.rst.
- NOTES on ``make config``: - NOTES on ``make config``:

5
Documentation/kbuild/headers_install.txt → Documentation/kbuild/headers_install.rst
View File

@ -1,3 +1,4 @@
=============================================
Exporting kernel headers for use by userspace Exporting kernel headers for use by userspace
============================================= =============================================
@ -22,14 +23,14 @@ older kernel.
The "make headers_install" command can be run in the top level directory of the The "make headers_install" command can be run in the top level directory of the
kernel source code (or using a standard out-of-tree build). It takes two kernel source code (or using a standard out-of-tree build). It takes two
optional arguments: optional arguments::
make headers_install ARCH=i386 INSTALL_HDR_PATH=/usr make headers_install ARCH=i386 INSTALL_HDR_PATH=/usr
ARCH indicates which architecture to produce headers for, and defaults to the ARCH indicates which architecture to produce headers for, and defaults to the
current architecture. The linux/asm directory of the exported kernel headers current architecture. The linux/asm directory of the exported kernel headers
is platform-specific, to see a complete list of supported architectures use is platform-specific, to see a complete list of supported architectures use
the command: the command::
ls -d include/asm-* | sed 's/.*-//' ls -d include/asm-* | sed 's/.*-//'

27
Documentation/kbuild/index.rst Normal file
View File

@ -0,0 +1,27 @@
:orphan:
===================
Kernel Build System
===================
.. toctree::
:maxdepth: 1
kconfig-language
kconfig-macro-language
kbuild
kconfig
makefiles
modules
headers_install
issues
.. only:: subproject and html
Indices
=======
* :ref:`genindex`

11
Documentation/kbuild/issues.rst Normal file
View File

@ -0,0 +1,11 @@
Recursion issue #1
------------------
.. include:: Kconfig.recursion-issue-01
:literal:
Recursion issue #2
------------------
.. include:: Kconfig.recursion-issue-02
:literal:

119
Documentation/kbuild/kbuild.txt → Documentation/kbuild/kbuild.rst
View File

@ -1,13 +1,19 @@
======
Kbuild
======
Output files Output files
============
modules.order modules.order
-------------------------------------------------- -------------
This file records the order in which modules appear in Makefiles. This This file records the order in which modules appear in Makefiles. This
is used by modprobe to deterministically resolve aliases that match is used by modprobe to deterministically resolve aliases that match
multiple modules. multiple modules.
modules.builtin modules.builtin
-------------------------------------------------- ---------------
This file lists all modules that are built into the kernel. This is used This file lists all modules that are built into the kernel. This is used
by modprobe to not fail when trying to load something builtin. by modprobe to not fail when trying to load something builtin.
@ -18,84 +24,90 @@ Unlike modinfo of a separate module, all fields are prefixed with module name.
Environment variables Environment variables
=====================
KCPPFLAGS KCPPFLAGS
-------------------------------------------------- ---------
Additional options to pass when preprocessing. The preprocessing options Additional options to pass when preprocessing. The preprocessing options
will be used in all cases where kbuild does preprocessing including will be used in all cases where kbuild does preprocessing including
building C files and assembler files. building C files and assembler files.
KAFLAGS KAFLAGS
-------------------------------------------------- -------
Additional options to the assembler (for built-in and modules). Additional options to the assembler (for built-in and modules).
AFLAGS_MODULE AFLAGS_MODULE
-------------------------------------------------- -------------
Additional module specific options to use for $(AS). Additional module specific options to use for $(AS).
AFLAGS_KERNEL AFLAGS_KERNEL
-------------------------------------------------- -------------
Additional options for $(AS) when used for assembler Additional options for $(AS) when used for assembler
code for code that is compiled as built-in. code for code that is compiled as built-in.
KCFLAGS KCFLAGS
-------------------------------------------------- -------
Additional options to the C compiler (for built-in and modules). Additional options to the C compiler (for built-in and modules).
CFLAGS_KERNEL CFLAGS_KERNEL
-------------------------------------------------- -------------
Additional options for $(CC) when used to compile Additional options for $(CC) when used to compile
code that is compiled as built-in. code that is compiled as built-in.
CFLAGS_MODULE CFLAGS_MODULE
-------------------------------------------------- -------------
Additional module specific options to use for $(CC). Additional module specific options to use for $(CC).
LDFLAGS_MODULE LDFLAGS_MODULE
-------------------------------------------------- --------------
Additional options used for $(LD) when linking modules. Additional options used for $(LD) when linking modules.
HOSTCFLAGS HOSTCFLAGS
-------------------------------------------------- ----------
Additional flags to be passed to $(HOSTCC) when building host programs. Additional flags to be passed to $(HOSTCC) when building host programs.
HOSTCXXFLAGS HOSTCXXFLAGS
-------------------------------------------------- ------------
Additional flags to be passed to $(HOSTCXX) when building host programs. Additional flags to be passed to $(HOSTCXX) when building host programs.
HOSTLDFLAGS HOSTLDFLAGS
-------------------------------------------------- -----------
Additional flags to be passed when linking host programs. Additional flags to be passed when linking host programs.
HOSTLDLIBS HOSTLDLIBS
-------------------------------------------------- ----------
Additional libraries to link against when building host programs. Additional libraries to link against when building host programs.
KBUILD_KCONFIG KBUILD_KCONFIG
-------------------------------------------------- --------------
Set the top-level Kconfig file to the value of this environment Set the top-level Kconfig file to the value of this environment
variable. The default name is "Kconfig". variable. The default name is "Kconfig".
KBUILD_VERBOSE KBUILD_VERBOSE
-------------------------------------------------- --------------
Set the kbuild verbosity. Can be assigned same values as "V=...". Set the kbuild verbosity. Can be assigned same values as "V=...".
See make help for the full list. See make help for the full list.
Setting "V=..." takes precedence over KBUILD_VERBOSE. Setting "V=..." takes precedence over KBUILD_VERBOSE.
KBUILD_EXTMOD KBUILD_EXTMOD
-------------------------------------------------- -------------
Set the directory to look for the kernel source when building external Set the directory to look for the kernel source when building external
modules. modules.
Setting "M=..." takes precedence over KBUILD_EXTMOD. Setting "M=..." takes precedence over KBUILD_EXTMOD.
KBUILD_OUTPUT KBUILD_OUTPUT
-------------------------------------------------- -------------
Specify the output directory when building the kernel. Specify the output directory when building the kernel.
The output directory can also be specified using "O=...". The output directory can also be specified using "O=...".
Setting "O=..." takes precedence over KBUILD_OUTPUT. Setting "O=..." takes precedence over KBUILD_OUTPUT.
KBUILD_DEBARCH KBUILD_DEBARCH
-------------------------------------------------- --------------
For the deb-pkg target, allows overriding the normal heuristics deployed by For the deb-pkg target, allows overriding the normal heuristics deployed by
deb-pkg. Normally deb-pkg attempts to guess the right architecture based on deb-pkg. Normally deb-pkg attempts to guess the right architecture based on
the UTS_MACHINE variable, and on some architectures also the kernel config. the UTS_MACHINE variable, and on some architectures also the kernel config.
@ -103,44 +115,48 @@ The value of KBUILD_DEBARCH is assumed (not checked) to be a valid Debian
architecture. architecture.
ARCH ARCH
-------------------------------------------------- ----
Set ARCH to the architecture to be built. Set ARCH to the architecture to be built.
In most cases the name of the architecture is the same as the In most cases the name of the architecture is the same as the
directory name found in the arch/ directory. directory name found in the arch/ directory.
But some architectures such as x86 and sparc have aliases. But some architectures such as x86 and sparc have aliases.
x86: i386 for 32 bit, x86_64 for 64 bit
sh: sh for 32 bit, sh64 for 64 bit - x86: i386 for 32 bit, x86_64 for 64 bit
sparc: sparc32 for 32 bit, sparc64 for 64 bit - sh: sh for 32 bit, sh64 for 64 bit
- sparc: sparc32 for 32 bit, sparc64 for 64 bit
CROSS_COMPILE CROSS_COMPILE
-------------------------------------------------- -------------
Specify an optional fixed part of the binutils filename. Specify an optional fixed part of the binutils filename.
CROSS_COMPILE can be a part of the filename or the full path. CROSS_COMPILE can be a part of the filename or the full path.
CROSS_COMPILE is also used for ccache in some setups. CROSS_COMPILE is also used for ccache in some setups.
CF CF
-------------------------------------------------- --
Additional options for sparse. Additional options for sparse.
CF is often used on the command-line like this:
CF is often used on the command-line like this::
make CF=-Wbitwise C=2 make CF=-Wbitwise C=2
INSTALL_PATH INSTALL_PATH
-------------------------------------------------- ------------
INSTALL_PATH specifies where to place the updated kernel and system map INSTALL_PATH specifies where to place the updated kernel and system map
images. Default is /boot, but you can set it to other values. images. Default is /boot, but you can set it to other values.
INSTALLKERNEL INSTALLKERNEL
-------------------------------------------------- -------------
Install script called when using "make install". Install script called when using "make install".
The default name is "installkernel". The default name is "installkernel".
The script will be called with the following arguments: The script will be called with the following arguments:
$1 - kernel version - $1 - kernel version
$2 - kernel image file - $2 - kernel image file
$3 - kernel map file - $3 - kernel map file
$4 - default install path (use root directory if blank) - $4 - default install path (use root directory if blank)
The implementation of "make install" is architecture specific The implementation of "make install" is architecture specific
and it may differ from the above. and it may differ from the above.
@ -149,32 +165,33 @@ INSTALLKERNEL is provided to enable the possibility to
specify a custom installer when cross compiling a kernel. specify a custom installer when cross compiling a kernel.
MODLIB MODLIB
-------------------------------------------------- ------
Specify where to install modules. Specify where to install modules.
The default value is: The default value is::
$(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE) $(INSTALL_MOD_PATH)/lib/modules/$(KERNELRELEASE)
The value can be overridden in which case the default value is ignored. The value can be overridden in which case the default value is ignored.
INSTALL_MOD_PATH INSTALL_MOD_PATH
-------------------------------------------------- ----------------
INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory INSTALL_MOD_PATH specifies a prefix to MODLIB for module directory
relocations required by build roots. This is not defined in the relocations required by build roots. This is not defined in the
makefile but the argument can be passed to make if needed. makefile but the argument can be passed to make if needed.
INSTALL_MOD_STRIP INSTALL_MOD_STRIP
-------------------------------------------------- -----------------
INSTALL_MOD_STRIP, if defined, will cause modules to be INSTALL_MOD_STRIP, if defined, will cause modules to be
stripped after they are installed. If INSTALL_MOD_STRIP is '1', then stripped after they are installed. If INSTALL_MOD_STRIP is '1', then
the default option --strip-debug will be used. Otherwise, the default option --strip-debug will be used. Otherwise,
INSTALL_MOD_STRIP value will be used as the options to the strip command. INSTALL_MOD_STRIP value will be used as the options to the strip command.
INSTALL_HDR_PATH INSTALL_HDR_PATH
-------------------------------------------------- ----------------
INSTALL_HDR_PATH specifies where to install user space headers when INSTALL_HDR_PATH specifies where to install user space headers when
executing "make headers_*". executing "make headers_*".
The default value is:
The default value is::
$(objtree)/usr $(objtree)/usr
@ -184,65 +201,65 @@ The output directory is often set using "O=..." on the commandline.
The value can be overridden in which case the default value is ignored. The value can be overridden in which case the default value is ignored.
KBUILD_SIGN_PIN KBUILD_SIGN_PIN
-------------------------------------------------- ---------------
This variable allows a passphrase or PIN to be passed to the sign-file This variable allows a passphrase or PIN to be passed to the sign-file
utility when signing kernel modules, if the private key requires such. utility when signing kernel modules, if the private key requires such.
KBUILD_MODPOST_WARN KBUILD_MODPOST_WARN
-------------------------------------------------- -------------------
KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined KBUILD_MODPOST_WARN can be set to avoid errors in case of undefined
symbols in the final module linking stage. It changes such errors symbols in the final module linking stage. It changes such errors
into warnings. into warnings.
KBUILD_MODPOST_NOFINAL KBUILD_MODPOST_NOFINAL
-------------------------------------------------- ----------------------
KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules. KBUILD_MODPOST_NOFINAL can be set to skip the final link of modules.
This is solely useful to speed up test compiles. This is solely useful to speed up test compiles.
KBUILD_EXTRA_SYMBOLS KBUILD_EXTRA_SYMBOLS
-------------------------------------------------- --------------------
For modules that use symbols from other modules. For modules that use symbols from other modules.
See more details in modules.txt. See more details in modules.txt.
ALLSOURCE_ARCHS ALLSOURCE_ARCHS
-------------------------------------------------- ---------------
For tags/TAGS/cscope targets, you can specify more than one arch For tags/TAGS/cscope targets, you can specify more than one arch
to be included in the databases, separated by blank space. E.g.: to be included in the databases, separated by blank space. E.g.::
$ make ALLSOURCE_ARCHS="x86 mips arm" tags $ make ALLSOURCE_ARCHS="x86 mips arm" tags
To get all available archs you can also specify all. E.g.: To get all available archs you can also specify all. E.g.::
$ make ALLSOURCE_ARCHS=all tags $ make ALLSOURCE_ARCHS=all tags
KBUILD_ENABLE_EXTRA_GCC_CHECKS KBUILD_ENABLE_EXTRA_GCC_CHECKS
-------------------------------------------------- ------------------------------
If enabled over the make command line with "W=1", it turns on additional If enabled over the make command line with "W=1", it turns on additional
gcc -W... options for more extensive build-time checking. gcc -W... options for more extensive build-time checking.
KBUILD_BUILD_TIMESTAMP KBUILD_BUILD_TIMESTAMP
-------------------------------------------------- ----------------------
Setting this to a date string overrides the timestamp used in the Setting this to a date string overrides the timestamp used in the
UTS_VERSION definition (uname -v in the running kernel). The value has to UTS_VERSION definition (uname -v in the running kernel). The value has to
be a string that can be passed to date -d. The default value be a string that can be passed to date -d. The default value
is the output of the date command at one point during build. is the output of the date command at one point during build.
KBUILD_BUILD_USER, KBUILD_BUILD_HOST KBUILD_BUILD_USER, KBUILD_BUILD_HOST
-------------------------------------------------- ------------------------------------
These two variables allow to override the user@host string displayed during These two variables allow to override the user@host string displayed during
boot and in /proc/version. The default value is the output of the commands boot and in /proc/version. The default value is the output of the commands
whoami and host, respectively. whoami and host, respectively.
KBUILD_LDS KBUILD_LDS
-------------------------------------------------- ----------
The linker script with full path. Assigned by the top-level Makefile. The linker script with full path. Assigned by the top-level Makefile.
KBUILD_VMLINUX_OBJS KBUILD_VMLINUX_OBJS
-------------------------------------------------- -------------------
All object files for vmlinux. They are linked to vmlinux in the same All object files for vmlinux. They are linked to vmlinux in the same
order as listed in KBUILD_VMLINUX_OBJS. order as listed in KBUILD_VMLINUX_OBJS.
KBUILD_VMLINUX_LIBS KBUILD_VMLINUX_LIBS
-------------------------------------------------- -------------------
All .a "lib" files for vmlinux. KBUILD_VMLINUX_OBJS and KBUILD_VMLINUX_LIBS All .a "lib" files for vmlinux. KBUILD_VMLINUX_OBJS and KBUILD_VMLINUX_LIBS
together specify all the object files used to link vmlinux. together specify all the object files used to link vmlinux.

138
Documentation/kbuild/kconfig-language.txt → Documentation/kbuild/kconfig-language.rst
View File

@ -1,8 +1,12 @@
================
Kconfig Language
================
Introduction Introduction
------------ ------------
The configuration database is a collection of configuration options The configuration database is a collection of configuration options
organized in a tree structure: organized in a tree structure::
+- Code maturity level options +- Code maturity level options
| +- Prompt for development and/or incomplete code/drivers | +- Prompt for development and/or incomplete code/drivers
@ -25,7 +29,7 @@ Menu entries
------------ ------------
Most entries define a config option; all other entries help to organize Most entries define a config option; all other entries help to organize
them. A single configuration option is defined like this: them. A single configuration option is defined like this::
config MODVERSIONS config MODVERSIONS
bool "Set version information on all module symbols" bool "Set version information on all module symbols"
@ -52,10 +56,12 @@ applicable everywhere (see syntax).
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 are based 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::
bool "Networking support" bool "Networking support"
and
and::
bool bool
prompt "Networking support" prompt "Networking support"
@ -98,8 +104,10 @@ applicable everywhere (see syntax).
d) Hardware or infrastructure that everybody expects, such as CONFIG_NET d) Hardware or infrastructure that everybody expects, such as CONFIG_NET
or CONFIG_BLOCK. These are rare exceptions. or CONFIG_BLOCK. These are rare exceptions.
- type definition + default value: - type definition + default value::
"def_bool"/"def_tristate" <expr> ["if" <expr>] "def_bool"/"def_tristate" <expr> ["if" <expr>]
This is a shorthand notation for a type definition plus a value. This is a shorthand notation for a type definition plus a value.
Optionally dependencies for this default value can be added with "if". Optionally dependencies for this default value can be added with "if".
@ -107,11 +115,13 @@ 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 an "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
and
and::
depends on BAR depends on BAR
bool "foo" bool "foo"
default y default y
@ -124,6 +134,7 @@ applicable everywhere (see syntax).
times, the limit is set to the largest selection. times, the limit is set to the largest selection.
Reverse dependencies can only be used with boolean or tristate Reverse dependencies can only be used with boolean or tristate
symbols. symbols.
Note: Note:
select should be used with care. select will force select should be used with care. select will force
a symbol to a value without visiting the dependencies. a symbol to a value without visiting the dependencies.
@ -139,7 +150,7 @@ applicable everywhere (see syntax).
symbol except that the "implied" symbol's value may still be set to n symbol except that the "implied" symbol's value may still be set to n
from a direct dependency or with a visible prompt. from a direct dependency or with a visible prompt.
Given the following example: Given the following example::
config FOO config FOO
tristate tristate
@ -151,12 +162,14 @@ applicable everywhere (see syntax).
The following values are possible: The following values are possible:
=== === ============= ==============
FOO BAR BAZ's default choice for BAZ FOO BAR BAZ's default choice for BAZ
--- --- ------------- -------------- === === ============= ==============
n y n N/m/y n y n N/m/y
m y m M/y/n m y m M/y/n
y y y Y/n y y y Y/n
y n * N y n * N
=== === ============= ==============
This is useful e.g. with multiple drivers that want to indicate their This is useful e.g. with multiple drivers that want to indicate their
ability to hook into a secondary subsystem while allowing the user to ability to hook into a secondary subsystem while allowing the user to
@ -208,7 +221,7 @@ Menu dependencies
Dependencies define the visibility of a menu entry and can also reduce Dependencies define the visibility of a menu entry and can also reduce
the input range of tristate symbols. The tristate logic used in the the input range of tristate symbols. The tristate logic used in the
expressions uses one more state than normal boolean logic to express the expressions uses one more state than normal boolean logic to express the
module state. Dependency expressions have the following syntax: module state. Dependency expressions have the following syntax::
<expr> ::= <symbol> (1) <expr> ::= <symbol> (1)
<symbol> '=' <symbol> (2) <symbol> '=' <symbol> (2)
@ -255,7 +268,7 @@ Menu structure
-------------- --------------
The position of a menu entry in the tree is determined in two ways. First The position of a menu entry in the tree is determined in two ways. First
it can be specified explicitly: it can be specified explicitly::
menu "Network device support" menu "Network device support"
depends on NET depends on NET
@ -275,8 +288,9 @@ dependencies. If a menu entry somehow depends on the previous entry, it
can be made a submenu of it. First, 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 conditions 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::
config MODULES config MODULES
bool "Enable loadable module support" bool "Enable loadable module support"
@ -299,6 +313,7 @@ Kconfig syntax
The configuration file describes a series of menu entries, where every 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 - menuconfig
- choice/endchoice - choice/endchoice
@ -306,17 +321,17 @@ end a menu entry:
- menu/endmenu - menu/endmenu
- if/endif - if/endif
- source - source
The first five also start the definition of a menu entry. The first five also start the definition of a menu entry.
config: config::
"config" <symbol> "config" <symbol>
<config options> <config options>
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::
"menuconfig" <symbol> "menuconfig" <symbol>
<config options> <config options>
@ -325,7 +340,7 @@ hint to front ends, that all suboptions should be displayed as a
separate list of options. To make sure all the suboptions will really separate list of options. To make sure all the suboptions will really
show up under the menuconfig entry and not outside of it, every item show up under the menuconfig entry and not outside of it, every item
from the <config options> list must depend on the menuconfig symbol. from the <config options> list must depend on the menuconfig symbol.
In practice, this is achieved by using one of the next two constructs: In practice, this is achieved by using one of the next two constructs::
(1): (1):
menuconfig M menuconfig M
@ -343,7 +358,7 @@ config C2
In the following examples (3) and (4), C1 and C2 still have the M In the following examples (3) and (4), C1 and C2 still have the M
dependency, but will not appear under menuconfig M anymore, because dependency, but will not appear under menuconfig M anymore, because
of C0, which doesn't depend on M: of C0, which doesn't depend on M::
(3): (3):
menuconfig M menuconfig M
@ -361,7 +376,7 @@ config C1
config C2 config C2
depends on M depends on M
choices: choices::
"choice" [symbol] "choice" [symbol]
<choice options> <choice options>
@ -387,7 +402,7 @@ definitions of that choice. If a [symbol] is associated to the choice,
then you may define the same choice (i.e. with the same entries) in another then you may define the same choice (i.e. with the same entries) in another
place. place.
comment: comment::
"comment" <prompt> "comment" <prompt>
<comment options> <comment options>
@ -396,7 +411,7 @@ This defines a comment which is displayed to the user during the
configuration process and is also echoed to the output files. The only configuration process and is also echoed to the output files. The only
possible options are dependencies. possible options are dependencies.
menu: menu::
"menu" <prompt> "menu" <prompt>
<menu options> <menu options>
@ -407,7 +422,7 @@ This defines a menu block, see "Menu structure" above for more
information. The only possible options are dependencies and "visible" information. The only possible options are dependencies and "visible"
attributes. attributes.
if: if::
"if" <expr> "if" <expr>
<if block> <if block>
@ -416,13 +431,13 @@ if:
This defines an if block. The dependency expression <expr> is appended This defines an if block. The dependency expression <expr> is appended
to all enclosed menu entries. to all enclosed menu entries.
source: source::
"source" <prompt> "source" <prompt>
This reads the specified configuration file. This file is always parsed. This reads the specified configuration file. This file is always parsed.
mainmenu: mainmenu::
"mainmenu" <prompt> "mainmenu" <prompt>
@ -452,7 +467,7 @@ that is defined in a common Kconfig file and selected by the relevant
architectures. architectures.
An example is the generic IOMAP functionality. An example is the generic IOMAP functionality.
We would in lib/Kconfig see: We would in lib/Kconfig see::
# Generic IOMAP is used to ... # Generic IOMAP is used to ...
config HAVE_GENERIC_IOMAP config HAVE_GENERIC_IOMAP
@ -460,10 +475,11 @@ config HAVE_GENERIC_IOMAP
config GENERIC_IOMAP config GENERIC_IOMAP
depends on HAVE_GENERIC_IOMAP && FOO depends on HAVE_GENERIC_IOMAP && FOO
And in lib/Makefile we would see: And in lib/Makefile we would see::
obj-$(CONFIG_GENERIC_IOMAP) += iomap.o obj-$(CONFIG_GENERIC_IOMAP) += iomap.o
For each architecture using the generic IOMAP functionality we would see: For each architecture using the generic IOMAP functionality we would see::
config X86 config X86
select ... select ...
@ -484,7 +500,7 @@ Adding features that need compiler support
There are several features that need compiler support. The recommended way There are several features that need compiler support. The recommended way
to describe the dependency on the compiler feature is to use "depends on" to describe the dependency on the compiler feature is to use "depends on"
followed by a test macro. followed by a test macro::
config STACKPROTECTOR config STACKPROTECTOR
bool "Stack Protector buffer overflow detection" bool "Stack Protector buffer overflow detection"
@ -492,7 +508,7 @@ config STACKPROTECTOR
... ...
If you need to expose a compiler capability to makefiles and/or C source files, If you need to expose a compiler capability to makefiles and/or C source files,
CC_HAS_ is the recommended prefix for the config option. `CC_HAS_` is the recommended prefix for the config option::
config CC_HAS_STACKPROTECTOR_NONE config CC_HAS_STACKPROTECTOR_NONE
def_bool $(cc-option,-fno-stack-protector) def_bool $(cc-option,-fno-stack-protector)
@ -500,7 +516,7 @@ config CC_HAS_STACKPROTECTOR_NONE
Build as module only Build as module only
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
To restrict a component build to module-only, qualify its config symbol To restrict a component build to module-only, qualify its config symbol
with "depends on m". E.g.: with "depends on m". E.g.::
config FOO config FOO
depends on BAR && m depends on BAR && m
@ -529,7 +545,7 @@ Simple Kconfig recursive issue
Read: Documentation/kbuild/Kconfig.recursion-issue-01 Read: Documentation/kbuild/Kconfig.recursion-issue-01
Test with: Test with::
make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-01 allnoconfig
@ -538,7 +554,7 @@ Cumulative Kconfig recursive issue
Read: Documentation/kbuild/Kconfig.recursion-issue-02 Read: Documentation/kbuild/Kconfig.recursion-issue-02
Test with: Test with::
make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig make KBUILD_KCONFIG=Documentation/kbuild/Kconfig.recursion-issue-02 allnoconfig
@ -551,7 +567,9 @@ historical issues resolved through these different solutions.
a) Remove any superfluous "select FOO" or "depends on FOO" a) Remove any superfluous "select FOO" or "depends on FOO"
b) Match dependency semantics: b) Match dependency semantics:
b1) Swap all "select FOO" to "depends on FOO" or, b1) Swap all "select FOO" to "depends on FOO" or,
b2) Swap all "depends on FOO" to "select FOO" b2) Swap all "depends on FOO" to "select FOO"
The resolution to a) can be tested with the sample Kconfig file The resolution to a) can be tested with the sample Kconfig file
@ -566,8 +584,9 @@ Documentation/kbuild/Kconfig.recursion-issue-02.
Below is a list of examples of prior fixes for these types of recursive issues; Below is a list of examples of prior fixes for these types of recursive issues;
all errors appear to involve one or more select's and one or more "depends on". all errors appear to involve one or more select's and one or more "depends on".
============ ===================================
commit fix commit fix
====== === ============ ===================================
06b718c01208 select A -> depends on A 06b718c01208 select A -> depends on A
c22eacfe82f9 depends on A -> depends on B c22eacfe82f9 depends on A -> depends on B
6a91e854442c select A -> depends on A 6a91e854442c select A -> depends on A
@ -590,6 +609,7 @@ d9f9ab51e55e select A -> depends on A
0c51a4d8abd6 depends on A -> select A (3) 0c51a4d8abd6 depends on A -> select A (3)
e98062ed6dc4 select A -> depends on A (3) e98062ed6dc4 select A -> depends on A (3)
91e5d284a7f1 select A -> (null) 91e5d284a7f1 select A -> (null)
============ ===================================
(1) Partial (or no) quote of error. (1) Partial (or no) quote of error.
(2) That seems to be the gist of that fix. (2) That seems to be the gist of that fix.
@ -616,11 +636,11 @@ Semantics of Kconfig
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
The use of Kconfig is broad, Linux is now only one of Kconfig's users: The use of Kconfig is broad, Linux is now only one of Kconfig's users:
one study has completed a broad analysis of Kconfig use in 12 projects [0]. one study has completed a broad analysis of Kconfig use in 12 projects [0]_.
Despite its widespread use, and although this document does a reasonable job Despite its widespread use, and although this document does a reasonable job
in documenting basic Kconfig syntax a more precise definition of Kconfig in documenting basic Kconfig syntax a more precise definition of Kconfig
semantics is welcomed. One project deduced Kconfig semantics through semantics is welcomed. One project deduced Kconfig semantics through
the use of the xconfig configurator [1]. Work should be done to confirm if the use of the xconfig configurator [1]_. Work should be done to confirm if
the deduced semantics matches our intended Kconfig design goals. the deduced semantics matches our intended Kconfig design goals.
Having well defined semantics can be useful for tools for practical Having well defined semantics can be useful for tools for practical
@ -628,42 +648,42 @@ evaluation of depenencies, for instance one such use known case was work to
express in boolean abstraction of the inferred semantics of Kconfig to express in boolean abstraction of the inferred semantics of Kconfig to
translate Kconfig logic into boolean formulas and run a SAT solver on this to translate Kconfig logic into boolean formulas and run a SAT solver on this to
find dead code / features (always inactive), 114 dead features were found in find dead code / features (always inactive), 114 dead features were found in
Linux using this methodology [1] (Section 8: Threats to validity). Linux using this methodology [1]_ (Section 8: Threats to validity).
Confirming this could prove useful as Kconfig stands as one of the the leading Confirming this could prove useful as Kconfig stands as one of the the leading
industrial variability modeling languages [1] [2]. Its study would help industrial variability modeling languages [1]_ [2]_. Its study would help
evaluate practical uses of such languages, their use was only theoretical evaluate practical uses of such languages, their use was only theoretical
and real world requirements were not well understood. As it stands though and real world requirements were not well understood. As it stands though
only reverse engineering techniques have been used to deduce semantics from only reverse engineering techniques have been used to deduce semantics from
variability modeling languages such as Kconfig [3]. variability modeling languages such as Kconfig [3]_.
[0] http://www.eng.uwaterloo.ca/~shshe/kconfig_semantics.pdf .. [0] http://www.eng.uwaterloo.ca/~shshe/kconfig_semantics.pdf
[1] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf .. [1] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
[2] http://gsd.uwaterloo.ca/sites/default/files/ase241-berger_0.pdf .. [2] http://gsd.uwaterloo.ca/sites/default/files/ase241-berger_0.pdf
[3] http://gsd.uwaterloo.ca/sites/default/files/icse2011.pdf .. [3] http://gsd.uwaterloo.ca/sites/default/files/icse2011.pdf
Full SAT solver for Kconfig Full SAT solver for Kconfig
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
Although SAT solvers [0] haven't yet been used by Kconfig directly, as noted in Although SAT solvers [4]_ haven't yet been used by Kconfig directly, as noted
the previous subsection, work has been done however to express in boolean in the previous subsection, work has been done however to express in boolean
abstraction the inferred semantics of Kconfig to translate Kconfig logic into abstraction the inferred semantics of Kconfig to translate Kconfig logic into
boolean formulas and run a SAT solver on it [1]. Another known related project boolean formulas and run a SAT solver on it [5]_. Another known related project
is CADOS [2] (former VAMOS [3]) and the tools, mainly undertaker [4], which has is CADOS [6]_ (former VAMOS [7]_) and the tools, mainly undertaker [8]_, which
been introduced first with [5]. The basic concept of undertaker is to exract has been introduced first with [9]_. The basic concept of undertaker is to
variability models from Kconfig, and put them together with a propositional exract variability models from Kconfig, and put them together with a
formula extracted from CPP #ifdefs and build-rules into a SAT solver in order propositional formula extracted from CPP #ifdefs and build-rules into a SAT
to find dead code, dead files, and dead symbols. If using a SAT solver is solver in order to find dead code, dead files, and dead symbols. If using a SAT
desirable on Kconfig one approach would be to evaluate repurposing such efforts solver is desirable on Kconfig one approach would be to evaluate repurposing
somehow on Kconfig. There is enough interest from mentors of existing projects such efforts somehow on Kconfig. There is enough interest from mentors of
to not only help advise how to integrate this work upstream but also help existing projects to not only help advise how to integrate this work upstream
maintain it long term. Interested developers should visit: but also help maintain it long term. Interested developers should visit:
http://kernelnewbies.org/KernelProjects/kconfig-sat http://kernelnewbies.org/KernelProjects/kconfig-sat
[0] http://www.cs.cornell.edu/~sabhar/chapters/SATSolvers-KR-Handbook.pdf .. [4] http://www.cs.cornell.edu/~sabhar/chapters/SATSolvers-KR-Handbook.pdf
[1] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf .. [5] http://gsd.uwaterloo.ca/sites/default/files/vm-2013-berger.pdf
[2] https://cados.cs.fau.de .. [6] https://cados.cs.fau.de
[3] https://vamos.cs.fau.de .. [7] https://vamos.cs.fau.de
[4] https://undertaker.cs.fau.de .. [8] https://undertaker.cs.fau.de
[5] https://www4.cs.fau.de/Publications/2011/tartler_11_eurosys.pdf .. [9] https://www4.cs.fau.de/Publications/2011/tartler_11_eurosys.pdf

37
Documentation/kbuild/kconfig-macro-language.txt → Documentation/kbuild/kconfig-macro-language.rst
View File

@ -1,3 +1,7 @@
======================
Kconfig macro language
======================
Concept Concept
------- -------
@ -7,7 +11,7 @@ targets and prerequisites. The other is a macro language for performing textual
substitution. substitution.
There is clear distinction between the two language stages. For example, you There is clear distinction between the two language stages. For example, you
can write a makefile like follows: can write a makefile like follows::
APP := foo APP := foo
SRC := foo.c SRC := foo.c
@ -17,7 +21,7 @@ can write a makefile like follows:
$(CC) -o $(APP) $(SRC) $(CC) -o $(APP) $(SRC)
The macro language replaces the variable references with their expanded form, The macro language replaces the variable references with their expanded form,
and handles as if the source file were input like follows: and handles as if the source file were input like follows::
foo: foo.c foo: foo.c
gcc -o foo foo.c gcc -o foo foo.c
@ -26,7 +30,7 @@ Then, Make analyzes the dependency graph and determines the targets to be
updated. updated.
The idea is quite similar in Kconfig - it is possible to describe a Kconfig The idea is quite similar in Kconfig - it is possible to describe a Kconfig
file like this: file like this::
CC := gcc CC := gcc
@ -34,7 +38,7 @@ file like this:
def_bool $(shell, $(srctree)/scripts/gcc-check-foo.sh $(CC)) def_bool $(shell, $(srctree)/scripts/gcc-check-foo.sh $(CC))
The macro language in Kconfig processes the source file into the following The macro language in Kconfig processes the source file into the following
intermediate: intermediate::
config CC_HAS_FOO config CC_HAS_FOO
def_bool y def_bool y
@ -69,7 +73,7 @@ variable. The righthand side of += is expanded immediately if the lefthand
side was originally defined as a simple variable. Otherwise, its evaluation is side was originally defined as a simple variable. Otherwise, its evaluation is
deferred. deferred.
The variable reference can take parameters, in the following form: The variable reference can take parameters, in the following form::
$(name,arg1,arg2,arg3) $(name,arg1,arg2,arg3)
@ -141,7 +145,7 @@ Make vs Kconfig
Kconfig adopts Make-like macro language, but the function call syntax is Kconfig adopts Make-like macro language, but the function call syntax is
slightly different. slightly different.
A function call in Make looks like this: A function call in Make looks like this::
$(func-name arg1,arg2,arg3) $(func-name arg1,arg2,arg3)
@ -149,14 +153,14 @@ The function name and the first argument are separated by at least one
whitespace. Then, leading whitespaces are trimmed from the first argument, whitespace. Then, leading whitespaces are trimmed from the first argument,
while whitespaces in the other arguments are kept. You need to use a kind of while whitespaces in the other arguments are kept. You need to use a kind of
trick to start the first parameter with spaces. For example, if you want trick to start the first parameter with spaces. For example, if you want
to make "info" function print " hello", you can write like follows: to make "info" function print " hello", you can write like follows::
empty := empty :=
space := $(empty) $(empty) space := $(empty) $(empty)
$(info $(space)$(space)hello) $(info $(space)$(space)hello)
Kconfig uses only commas for delimiters, and keeps all whitespaces in the Kconfig uses only commas for delimiters, and keeps all whitespaces in the
function call. Some people prefer putting a space after each comma delimiter: function call. Some people prefer putting a space after each comma delimiter::
$(func-name, arg1, arg2, arg3) $(func-name, arg1, arg2, arg3)
@ -166,7 +170,7 @@ Make - for example, $(subst .c, .o, $(sources)) is a typical mistake; it
replaces ".c" with " .o". replaces ".c" with " .o".
In Make, a user-defined function is referenced by using a built-in function, In Make, a user-defined function is referenced by using a built-in function,
'call', like this: 'call', like this::
$(call my-func,arg1,arg2,arg3) $(call my-func,arg1,arg2,arg3)
@ -179,12 +183,12 @@ Likewise, $(info hello, world) prints "hello, world" to stdout. You could say
this is _useful_ inconsistency. this is _useful_ inconsistency.
In Kconfig, for simpler implementation and grammatical consistency, commas that In Kconfig, for simpler implementation and grammatical consistency, commas that
appear in the $( ) context are always delimiters. It means appear in the $( ) context are always delimiters. It means::
$(shell, echo hello, world) $(shell, echo hello, world)
is an error because it is passing two parameters where the 'shell' function is an error because it is passing two parameters where the 'shell' function
accepts only one. To pass commas in arguments, you can use the following trick: accepts only one. To pass commas in arguments, you can use the following trick::
comma := , comma := ,
$(shell, echo hello$(comma) world) $(shell, echo hello$(comma) world)
@ -195,7 +199,7 @@ Caveats
A variable (or function) cannot be expanded across tokens. So, you cannot use A variable (or function) cannot be expanded across tokens. So, you cannot use
a variable as a shorthand for an expression that consists of multiple tokens. a variable as a shorthand for an expression that consists of multiple tokens.
The following works: The following works::
RANGE_MIN := 1 RANGE_MIN := 1
RANGE_MAX := 3 RANGE_MAX := 3
@ -204,7 +208,7 @@ The following works:
int "foo" int "foo"
range $(RANGE_MIN) $(RANGE_MAX) range $(RANGE_MIN) $(RANGE_MAX)
But, the following does not work: But, the following does not work::
RANGES := 1 3 RANGES := 1 3
@ -213,7 +217,7 @@ But, the following does not work:
range $(RANGES) range $(RANGES)
A variable cannot be expanded to any keyword in Kconfig. The following does A variable cannot be expanded to any keyword in Kconfig. The following does
not work: not work::
MY_TYPE := tristate MY_TYPE := tristate
@ -223,7 +227,8 @@ not work:
Obviously from the design, $(shell command) is expanded in the textual Obviously from the design, $(shell command) is expanded in the textual
substitution phase. You cannot pass symbols to the 'shell' function. substitution phase. You cannot pass symbols to the 'shell' function.
The following does not work as expected.
The following does not work as expected::
config ENDIAN_FLAG config ENDIAN_FLAG
string string
@ -234,7 +239,7 @@ The following does not work as expected.
def_bool $(shell $(srctree)/scripts/gcc-check-flag ENDIAN_FLAG) def_bool $(shell $(srctree)/scripts/gcc-check-flag ENDIAN_FLAG)
Instead, you can do like follows so that any function call is statically Instead, you can do like follows so that any function call is statically
expanded. expanded::
config CC_HAS_ENDIAN_FLAG config CC_HAS_ENDIAN_FLAG
bool bool

136
Documentation/kbuild/kconfig.txt → Documentation/kbuild/kconfig.rst
View File

@ -1,4 +1,8 @@
This file contains some assistance for using "make *config". ===================
Kconfig make config
===================
This file contains some assistance for using `make *config`.
Use "make help" to list all of the possible configuration targets. Use "make help" to list all of the possible configuration targets.
@ -6,9 +10,8 @@ The xconfig ('qconf'), menuconfig ('mconf'), and nconfig ('nconf')
programs also have embedded help text. Be sure to check that for programs also have embedded help text. Be sure to check that for
navigation, search, and other general help text. navigation, search, and other general help text.
======================================================================
General General
-------------------------------------------------- -------
New kernel releases often introduce new config symbols. Often more New kernel releases often introduce new config symbols. Often more
important, new kernel releases may rename config symbols. When important, new kernel releases may rename config symbols. When
@ -17,51 +20,55 @@ this happens, using a previously working .config file and running
for you, so you may find that you need to see what NEW kernel for you, so you may find that you need to see what NEW kernel
symbols have been introduced. symbols have been introduced.
To see a list of new config symbols, use To see a list of new config symbols, use::
cp user/some/old.config .config cp user/some/old.config .config
make listnewconfig make listnewconfig
and the config program will list any new symbols, one per line. and the config program will list any new symbols, one per line.
Alternatively, you can use the brute force method: Alternatively, you can use the brute force method::
make oldconfig make oldconfig
scripts/diffconfig .config.old .config | less scripts/diffconfig .config.old .config | less
______________________________________________________________________ ----------------------------------------------------------------------
Environment variables for '*config'
Environment variables for `*config`
KCONFIG_CONFIG KCONFIG_CONFIG
-------------------------------------------------- --------------
This environment variable can be used to specify a default kernel config This environment variable can be used to specify a default kernel config
file name to override the default name of ".config". file name to override the default name of ".config".
KCONFIG_OVERWRITECONFIG KCONFIG_OVERWRITECONFIG
-------------------------------------------------- -----------------------
If you set KCONFIG_OVERWRITECONFIG in the environment, Kconfig will not If you set KCONFIG_OVERWRITECONFIG in the environment, Kconfig will not
break symlinks when .config is a symlink to somewhere else. break symlinks when .config is a symlink to somewhere else.
CONFIG_ `CONFIG_`
-------------------------------------------------- ---------
If you set CONFIG_ in the environment, Kconfig will prefix all symbols If you set `CONFIG_` in the environment, Kconfig will prefix all symbols
with its value when saving the configuration, instead of using the default, with its value when saving the configuration, instead of using the default,
"CONFIG_". `CONFIG_`.
----------------------------------------------------------------------
______________________________________________________________________
Environment variables for '{allyes/allmod/allno/rand}config' Environment variables for '{allyes/allmod/allno/rand}config'
KCONFIG_ALLCONFIG KCONFIG_ALLCONFIG
-------------------------------------------------- -----------------
(partially based on lkml email from/by Rob Landley, re: miniconfig) (partially based on lkml email from/by Rob Landley, re: miniconfig)
-------------------------------------------------- --------------------------------------------------
The allyesconfig/allmodconfig/allnoconfig/randconfig variants can also The allyesconfig/allmodconfig/allnoconfig/randconfig variants can also
use the environment variable KCONFIG_ALLCONFIG as a flag or a filename use the environment variable KCONFIG_ALLCONFIG as a flag or a filename
that contains config symbols that the user requires to be set to a that contains config symbols that the user requires to be set to a
specific value. If KCONFIG_ALLCONFIG is used without a filename where specific value. If KCONFIG_ALLCONFIG is used without a filename where
KCONFIG_ALLCONFIG == "" or KCONFIG_ALLCONFIG == "1", "make *config" KCONFIG_ALLCONFIG == "" or KCONFIG_ALLCONFIG == "1", `make *config`
checks for a file named "all{yes/mod/no/def/random}.config" checks for a file named "all{yes/mod/no/def/random}.config"
(corresponding to the *config command that was used) for symbol values (corresponding to the `*config` command that was used) for symbol values
that are to be forced. If this file is not found, it checks for a that are to be forced. If this file is not found, it checks for a
file named "all.config" to contain forced values. file named "all.config" to contain forced values.
@ -74,43 +81,55 @@ This 'KCONFIG_ALLCONFIG' file is a config file which contains
(usually a subset of all) preset config symbols. These variable (usually a subset of all) preset config symbols. These variable
settings are still subject to normal dependency checks. settings are still subject to normal dependency checks.
Examples: Examples::
KCONFIG_ALLCONFIG=custom-notebook.config make allnoconfig KCONFIG_ALLCONFIG=custom-notebook.config make allnoconfig
or
or::
KCONFIG_ALLCONFIG=mini.config make allnoconfig KCONFIG_ALLCONFIG=mini.config make allnoconfig
or
or::
make KCONFIG_ALLCONFIG=mini.config allnoconfig make KCONFIG_ALLCONFIG=mini.config allnoconfig
These examples will disable most options (allnoconfig) but enable or These examples will disable most options (allnoconfig) but enable or
disable the options that are explicitly listed in the specified disable the options that are explicitly listed in the specified
mini-config files. mini-config files.
______________________________________________________________________ ----------------------------------------------------------------------
Environment variables for 'randconfig' Environment variables for 'randconfig'
KCONFIG_SEED KCONFIG_SEED
-------------------------------------------------- ------------
You can set this to the integer value used to seed the RNG, if you want You can set this to the integer value used to seed the RNG, if you want
to somehow debug the behaviour of the kconfig parser/frontends. to somehow debug the behaviour of the kconfig parser/frontends.
If not set, the current time will be used. If not set, the current time will be used.
KCONFIG_PROBABILITY KCONFIG_PROBABILITY
-------------------------------------------------- -------------------
This variable can be used to skew the probabilities. This variable can This variable can be used to skew the probabilities. This variable can
be unset or empty, or set to three different formats: be unset or empty, or set to three different formats:
======================= ================== =====================
KCONFIG_PROBABILITY y:n split y:m:n split KCONFIG_PROBABILITY y:n split y:m:n split
----------------------------------------------------------------- ======================= ================== =====================
unset or empty 50 : 50 33 : 33 : 34 unset or empty 50 : 50 33 : 33 : 34
N N : 100-N N/2 : N/2 : 100-N N N : 100-N N/2 : N/2 : 100-N
[1] N:M N+M : 100-(N+M) N : M : 100-(N+M) [1] N:M N+M : 100-(N+M) N : M : 100-(N+M)
[2] N:M:L N : 100-N M : L : 100-(M+L) [2] N:M:L N : 100-N M : L : 100-(M+L)
======================= ================== =====================
where N, M and L are integers (in base 10) in the range [0,100], and so where N, M and L are integers (in base 10) in the range [0,100], and so
that: that:
[1] N+M is in the range [0,100] [1] N+M is in the range [0,100]
[2] M+L is in the range [0,100] [2] M+L is in the range [0,100]
Examples: Examples::
KCONFIG_PROBABILITY=10 KCONFIG_PROBABILITY=10
10% of booleans will be set to 'y', 90% to 'n' 10% of booleans will be set to 'y', 90% to 'n'
5% of tristates will be set to 'y', 5% to 'm', 90% to 'n' 5% of tristates will be set to 'y', 5% to 'm', 90% to 'n'
@ -121,34 +140,36 @@ Examples:
10% of booleans will be set to 'y', 90% to 'n' 10% of booleans will be set to 'y', 90% to 'n'
15% of tristates will be set to 'y', 15% to 'm', 70% to 'n' 15% of tristates will be set to 'y', 15% to 'm', 70% to 'n'
______________________________________________________________________ ----------------------------------------------------------------------
Environment variables for 'syncconfig' Environment variables for 'syncconfig'
KCONFIG_NOSILENTUPDATE KCONFIG_NOSILENTUPDATE
-------------------------------------------------- ----------------------
If this variable has a non-blank value, it prevents silent kernel If this variable has a non-blank value, it prevents silent kernel
config updates (requires explicit updates). config updates (requires explicit updates).
KCONFIG_AUTOCONFIG KCONFIG_AUTOCONFIG
-------------------------------------------------- ------------------
This environment variable can be set to specify the path & name of the This environment variable can be set to specify the path & name of the
"auto.conf" file. Its default value is "include/config/auto.conf". "auto.conf" file. Its default value is "include/config/auto.conf".
KCONFIG_TRISTATE KCONFIG_TRISTATE
-------------------------------------------------- ----------------
This environment variable can be set to specify the path & name of the This environment variable can be set to specify the path & name of the
"tristate.conf" file. Its default value is "include/config/tristate.conf". "tristate.conf" file. Its default value is "include/config/tristate.conf".
KCONFIG_AUTOHEADER KCONFIG_AUTOHEADER
-------------------------------------------------- ------------------
This environment variable can be set to specify the path & name of the This environment variable can be set to specify the path & name of the
"autoconf.h" (header) file. "autoconf.h" (header) file.
Its default value is "include/generated/autoconf.h". Its default value is "include/generated/autoconf.h".
====================================================================== ----------------------------------------------------------------------
menuconfig menuconfig
-------------------------------------------------- ----------
SEARCHING for CONFIG symbols SEARCHING for CONFIG symbols
@ -158,7 +179,8 @@ Searching in menuconfig:
names, so you have to know something close to what you are names, so you have to know something close to what you are
looking for. looking for.
Example: Example::
/hotplug /hotplug
This lists all config symbols that contain "hotplug", This lists all config symbols that contain "hotplug",
e.g., HOTPLUG_CPU, MEMORY_HOTPLUG. e.g., HOTPLUG_CPU, MEMORY_HOTPLUG.
@ -166,48 +188,55 @@ Searching in menuconfig:
For search help, enter / followed by TAB-TAB (to highlight For search help, enter / followed by TAB-TAB (to highlight
<Help>) and Enter. This will tell you that you can also use <Help>) and Enter. This will tell you that you can also use
regular expressions (regexes) in the search string, so if you regular expressions (regexes) in the search string, so if you
are not interested in MEMORY_HOTPLUG, you could try are not interested in MEMORY_HOTPLUG, you could try::
/^hotplug /^hotplug
When searching, symbols are sorted thus: When searching, symbols are sorted thus:
- first, exact matches, sorted alphabetically (an exact match - first, exact matches, sorted alphabetically (an exact match
is when the search matches the complete symbol name); is when the search matches the complete symbol name);
- then, other matches, sorted alphabetically. - then, other matches, sorted alphabetically.
For example: ^ATH.K matches: For example: ^ATH.K matches:
ATH5K ATH9K ATH5K_AHB ATH5K_DEBUG [...] ATH6KL ATH6KL_DEBUG ATH5K ATH9K ATH5K_AHB ATH5K_DEBUG [...] ATH6KL ATH6KL_DEBUG
[...] ATH9K_AHB ATH9K_BTCOEX_SUPPORT ATH9K_COMMON [...] [...] ATH9K_AHB ATH9K_BTCOEX_SUPPORT ATH9K_COMMON [...]
of which only ATH5K and ATH9K match exactly and so are sorted of which only ATH5K and ATH9K match exactly and so are sorted
first (and in alphabetical order), then come all other symbols, first (and in alphabetical order), then come all other symbols,
sorted in alphabetical order. sorted in alphabetical order.
______________________________________________________________________ ----------------------------------------------------------------------
User interface options for 'menuconfig' User interface options for 'menuconfig'
MENUCONFIG_COLOR MENUCONFIG_COLOR
-------------------------------------------------- ----------------
It is possible to select different color themes using the variable It is possible to select different color themes using the variable
MENUCONFIG_COLOR. To select a theme use: MENUCONFIG_COLOR. To select a theme use::
make MENUCONFIG_COLOR=<theme> menuconfig make MENUCONFIG_COLOR=<theme> menuconfig
Available themes are: Available themes are::
mono => selects colors suitable for monochrome displays
blackbg => selects a color scheme with black background - mono => selects colors suitable for monochrome displays
classic => theme with blue background. The classic look - blackbg => selects a color scheme with black background
bluetitle => a LCD friendly version of classic. (default) - classic => theme with blue background. The classic look
- bluetitle => a LCD friendly version of classic. (default)
MENUCONFIG_MODE MENUCONFIG_MODE
-------------------------------------------------- ---------------
This mode shows all sub-menus in one large tree. This mode shows all sub-menus in one large tree.
Example: Example::
make MENUCONFIG_MODE=single_menu menuconfig make MENUCONFIG_MODE=single_menu menuconfig
----------------------------------------------------------------------
======================================================================
nconfig nconfig
-------------------------------------------------- -------
nconfig is an alternate text-based configurator. It lists function nconfig is an alternate text-based configurator. It lists function
keys across the bottom of the terminal (window) that execute commands. keys across the bottom of the terminal (window) that execute commands.
@ -231,16 +260,16 @@ Searching in nconfig:
given string or regular expression (regex). given string or regular expression (regex).
NCONFIG_MODE NCONFIG_MODE
-------------------------------------------------- ------------
This mode shows all sub-menus in one large tree. This mode shows all sub-menus in one large tree.
Example: Example::
make NCONFIG_MODE=single_menu nconfig make NCONFIG_MODE=single_menu nconfig
----------------------------------------------------------------------
======================================================================
xconfig xconfig
-------------------------------------------------- -------
Searching in xconfig: Searching in xconfig:
@ -260,13 +289,12 @@ Searching in xconfig:
to return to the main menu. to return to the main menu.
====================================================================== ----------------------------------------------------------------------
gconfig gconfig
-------------------------------------------------- -------
Searching in gconfig: Searching in gconfig:
There is no search command in gconfig. However, gconfig does There is no search command in gconfig. However, gconfig does
have several different viewing choices, modes, and options. have several different viewing choices, modes, and options.
###

452
Documentation/kbuild/makefiles.txt → Documentation/kbuild/makefiles.rst
View File

File diff suppressed because it is too large Load Diff

136
Documentation/kbuild/modules.txt → Documentation/kbuild/modules.rst
View File

@ -1,8 +1,10 @@
=========================
Building External Modules Building External Modules
=========================
This document describes how to build an out-of-tree kernel module. This document describes how to build an out-of-tree kernel module.
=== Table of Contents .. Table of Contents
=== 1 Introduction === 1 Introduction
=== 2 How to Build External Modules === 2 How to Build External Modules
@ -31,7 +33,8 @@ This document describes how to build an out-of-tree kernel module.
=== 1. Introduction 1. Introduction
===============
"kbuild" is the build system used by the Linux kernel. Modules must use "kbuild" is the build system used by the Linux kernel. Modules must use
kbuild to stay compatible with changes in the build infrastructure and kbuild to stay compatible with changes in the build infrastructure and
@ -48,7 +51,8 @@ easily accomplished, and a complete example will be presented in
section 3. section 3.
=== 2. How to Build External Modules 2. How to Build External Modules
================================
To build external modules, you must have a prebuilt kernel available To build external modules, you must have a prebuilt kernel available
that contains the configuration and header files used in the build. that contains the configuration and header files used in the build.
@ -65,25 +69,27 @@ NOTE: "modules_prepare" will not build Module.symvers even if
CONFIG_MODVERSIONS is set; therefore, a full kernel build needs to be CONFIG_MODVERSIONS is set; therefore, a full kernel build needs to be
executed to make module versioning work. executed to make module versioning work.
--- 2.1 Command Syntax 2.1 Command Syntax
==================
The command to build an external module is: The command to build an external module is::
$ make -C <path_to_kernel_src> M=$PWD $ make -C <path_to_kernel_src> M=$PWD
The kbuild system knows that an external module is being built The kbuild system knows that an external module is being built
due to the "M=<dir>" option given in the command. due to the "M=<dir>" option given in the command.
To build against the running kernel use: To build against the running kernel use::
$ make -C /lib/modules/`uname -r`/build M=$PWD $ make -C /lib/modules/`uname -r`/build M=$PWD
Then to install the module(s) just built, add the target Then to install the module(s) just built, add the target
"modules_install" to the command: "modules_install" to the command::
$ make -C /lib/modules/`uname -r`/build M=$PWD modules_install $ make -C /lib/modules/`uname -r`/build M=$PWD modules_install
--- 2.2 Options 2.2 Options
===========
($KDIR refers to the path of the kernel source directory.) ($KDIR refers to the path of the kernel source directory.)
@ -100,7 +106,8 @@ executed to make module versioning work.
directory where the external module (kbuild file) is directory where the external module (kbuild file) is
located. located.
--- 2.3 Targets 2.3 Targets
===========
When building an external module, only a subset of the "make" When building an external module, only a subset of the "make"
targets are available. targets are available.
@ -130,26 +137,29 @@ executed to make module versioning work.
help help
List the available targets for external modules. List the available targets for external modules.
--- 2.4 Building Separate Files 2.4 Building Separate Files
===========================
It is possible to build single files that are part of a module. It is possible to build single files that are part of a module.
This works equally well for the kernel, a module, and even for This works equally well for the kernel, a module, and even for
external modules. external modules.
Example (The module foo.ko, consist of bar.o and baz.o): Example (The module foo.ko, consist of bar.o and baz.o)::
make -C $KDIR M=$PWD bar.lst make -C $KDIR M=$PWD bar.lst
make -C $KDIR M=$PWD baz.o make -C $KDIR M=$PWD baz.o
make -C $KDIR M=$PWD foo.ko make -C $KDIR M=$PWD foo.ko
make -C $KDIR M=$PWD ./ make -C $KDIR M=$PWD ./
=== 3. Creating a Kbuild File for an External Module 3. Creating a Kbuild File for an External Module
================================================
In the last section we saw the command to build a module for the In the last section we saw the command to build a module for the
running kernel. The module is not actually built, however, because a running kernel. The module is not actually built, however, because a
build file is required. Contained in this file will be the name of build file is required. Contained in this file will be the name of
the module(s) being built, along with the list of requisite source the module(s) being built, along with the list of requisite source
files. The file may be as simple as a single line: files. The file may be as simple as a single line::
obj-m := <module_name>.o obj-m := <module_name>.o
@ -157,15 +167,15 @@ The kbuild system will build <module_name>.o from <module_name>.c,
and, after linking, will result in the kernel module <module_name>.ko. and, after linking, will result in the kernel module <module_name>.ko.
The above line can be put in either a "Kbuild" file or a "Makefile." The above line can be put in either a "Kbuild" file or a "Makefile."
When the module is built from multiple sources, an additional line is When the module is built from multiple sources, an additional line is
needed listing the files: needed listing the files::
<module_name>-y := <src1>.o <src2>.o ... <module_name>-y := <src1>.o <src2>.o ...
NOTE: Further documentation describing the syntax used by kbuild is NOTE: Further documentation describing the syntax used by kbuild is
located in Documentation/kbuild/makefiles.txt. located in Documentation/kbuild/makefiles.rst.
The examples below demonstrate how to create a build file for the The examples below demonstrate how to create a build file for the
module 8123.ko, which is built from the following files: module 8123.ko, which is built from the following files::
8123_if.c 8123_if.c
8123_if.h 8123_if.h
@ -181,7 +191,8 @@ module 8123.ko, which is built from the following files:
but should be filtered out from kbuild due to possible name but should be filtered out from kbuild due to possible name
clashes. clashes.
Example 1: Example 1::
--> filename: Makefile --> filename: Makefile
ifneq ($(KERNELRELEASE),) ifneq ($(KERNELRELEASE),)
# kbuild part of makefile # kbuild part of makefile
@ -209,14 +220,16 @@ module 8123.ko, which is built from the following files:
line; the second pass is by the kbuild system, which is line; the second pass is by the kbuild system, which is
initiated by the parameterized "make" in the default target. initiated by the parameterized "make" in the default target.
--- 3.2 Separate Kbuild File and Makefile 3.2 Separate Kbuild File and Makefile
-------------------------------------
In newer versions of the kernel, kbuild will first look for a In newer versions of the kernel, kbuild will first look for a
file named "Kbuild," and only if that is not found, will it file named "Kbuild," and only if that is not found, will it
then look for a makefile. Utilizing a "Kbuild" file allows us then look for a makefile. Utilizing a "Kbuild" file allows us
to split up the makefile from example 1 into two files: to split up the makefile from example 1 into two files:
Example 2: Example 2::
--> filename: Kbuild --> filename: Kbuild
obj-m := 8123.o obj-m := 8123.o
8123-y := 8123_if.o 8123_pci.o 8123_bin.o 8123-y := 8123_if.o 8123_pci.o 8123_bin.o
@ -238,7 +251,8 @@ module 8123.ko, which is built from the following files:
The next example shows a backward compatible version. The next example shows a backward compatible version.
Example 3: Example 3::
--> filename: Kbuild --> filename: Kbuild
obj-m := 8123.o obj-m := 8123.o
8123-y := 8123_if.o 8123_pci.o 8123_bin.o 8123-y := 8123_if.o 8123_pci.o 8123_bin.o
@ -266,7 +280,8 @@ module 8123.ko, which is built from the following files:
makefiles, to be used when the "make" and kbuild parts are makefiles, to be used when the "make" and kbuild parts are
split into separate files. split into separate files.
--- 3.3 Binary Blobs 3.3 Binary Blobs
----------------
Some external modules need to include an object file as a blob. Some external modules need to include an object file as a blob.
kbuild has support for this, but requires the blob file to be kbuild has support for this, but requires the blob file to be
@ -277,7 +292,7 @@ module 8123.ko, which is built from the following files:
Throughout this section, 8123_bin.o_shipped has been used to Throughout this section, 8123_bin.o_shipped has been used to
build the kernel module 8123.ko; it has been included as build the kernel module 8123.ko; it has been included as
8123_bin.o. 8123_bin.o::
8123-y := 8123_if.o 8123_pci.o 8123_bin.o 8123-y := 8123_if.o 8123_pci.o 8123_bin.o
@ -285,11 +300,12 @@ module 8123.ko, which is built from the following files:
files and the binary file, kbuild will pick up different rules files and the binary file, kbuild will pick up different rules
when creating the object file for the module. when creating the object file for the module.
--- 3.4 Building Multiple Modules 3.4 Building Multiple Modules
=============================
kbuild supports building multiple modules with a single build kbuild supports building multiple modules with a single build
file. For example, if you wanted to build two modules, foo.ko file. For example, if you wanted to build two modules, foo.ko
and bar.ko, the kbuild lines would be: and bar.ko, the kbuild lines would be::
obj-m := foo.o bar.o obj-m := foo.o bar.o
foo-y := <foo_srcs> foo-y := <foo_srcs>
@ -298,7 +314,8 @@ module 8123.ko, which is built from the following files:
It is that simple! It is that simple!
=== 4. Include Files 4. Include Files
================
Within the kernel, header files are kept in standard locations Within the kernel, header files are kept in standard locations
according to the following rule: according to the following rule:
@ -310,22 +327,25 @@ according to the following rule:
of the kernel that are located in different directories, then of the kernel that are located in different directories, then
the file is placed in include/linux/. the file is placed in include/linux/.
NOTE: There are two notable exceptions to this rule: larger NOTE:
There are two notable exceptions to this rule: larger
subsystems have their own directory under include/, such as subsystems have their own directory under include/, such as
include/scsi; and architecture specific headers are located include/scsi; and architecture specific headers are located
under arch/$(ARCH)/include/. under arch/$(ARCH)/include/.
--- 4.1 Kernel Includes 4.1 Kernel Includes
-------------------
To include a header file located under include/linux/, simply To include a header file located under include/linux/, simply
use: use::
#include <linux/module.h> #include <linux/module.h>
kbuild will add options to "gcc" so the relevant directories kbuild will add options to "gcc" so the relevant directories
are searched. are searched.
--- 4.2 Single Subdirectory 4.2 Single Subdirectory
-----------------------
External modules tend to place header files in a separate External modules tend to place header files in a separate
include/ directory where their source is located, although this include/ directory where their source is located, although this
@ -334,7 +354,7 @@ according to the following rule:
Using the example from section 3, if we moved 8123_if.h to a Using the example from section 3, if we moved 8123_if.h to a
subdirectory named include, the resulting kbuild file would subdirectory named include, the resulting kbuild file would
look like: look like::
--> filename: Kbuild --> filename: Kbuild
obj-m := 8123.o obj-m := 8123.o
@ -346,10 +366,11 @@ according to the following rule:
the path. This is a limitation of kbuild: there must be no the path. This is a limitation of kbuild: there must be no
space present. space present.
--- 4.3 Several Subdirectories 4.3 Several Subdirectories
--------------------------
kbuild can handle files that are spread over several directories. kbuild can handle files that are spread over several directories.
Consider the following example: Consider the following example::
. .
|__ src |__ src
@ -362,7 +383,7 @@ according to the following rule:
|__ complex.h |__ complex.h
To build the module complex.ko, we then need the following To build the module complex.ko, we then need the following
kbuild file: kbuild file::
--> filename: Kbuild --> filename: Kbuild
obj-m := complex.o obj-m := complex.o
@ -385,7 +406,8 @@ according to the following rule:
file is located. file is located.
=== 5. Module Installation 5. Module Installation
======================
Modules which are included in the kernel are installed in the Modules which are included in the kernel are installed in the
directory: directory:
@ -396,11 +418,12 @@ And external modules are installed in:
/lib/modules/$(KERNELRELEASE)/extra/ /lib/modules/$(KERNELRELEASE)/extra/
--- 5.1 INSTALL_MOD_PATH 5.1 INSTALL_MOD_PATH
--------------------
Above are the default directories but as always some level of Above are the default directories but as always some level of
customization is possible. A prefix can be added to the customization is possible. A prefix can be added to the
installation path using the variable INSTALL_MOD_PATH: installation path using the variable INSTALL_MOD_PATH::
$ make INSTALL_MOD_PATH=/frodo modules_install $ make INSTALL_MOD_PATH=/frodo modules_install
=> Install dir: /frodo/lib/modules/$(KERNELRELEASE)/kernel/ => Install dir: /frodo/lib/modules/$(KERNELRELEASE)/kernel/
@ -410,20 +433,22 @@ And external modules are installed in:
calling "make." This has effect when installing both in-tree calling "make." This has effect when installing both in-tree
and out-of-tree modules. and out-of-tree modules.
--- 5.2 INSTALL_MOD_DIR 5.2 INSTALL_MOD_DIR
-------------------
External modules are by default installed to a directory under External modules are by default installed to a directory under
/lib/modules/$(KERNELRELEASE)/extra/, but you may wish to /lib/modules/$(KERNELRELEASE)/extra/, but you may wish to
locate modules for a specific functionality in a separate locate modules for a specific functionality in a separate
directory. For this purpose, use INSTALL_MOD_DIR to specify an directory. For this purpose, use INSTALL_MOD_DIR to specify an
alternative name to "extra." alternative name to "extra."::
$ make INSTALL_MOD_DIR=gandalf -C $KDIR \ $ make INSTALL_MOD_DIR=gandalf -C $KDIR \
M=$PWD modules_install M=$PWD modules_install
=> Install dir: /lib/modules/$(KERNELRELEASE)/gandalf/ => Install dir: /lib/modules/$(KERNELRELEASE)/gandalf/
=== 6. Module Versioning 6. Module Versioning
====================
Module versioning is enabled by the CONFIG_MODVERSIONS tag, and is used Module versioning is enabled by the CONFIG_MODVERSIONS tag, and is used
as a simple ABI consistency check. A CRC value of the full prototype as a simple ABI consistency check. A CRC value of the full prototype
@ -435,14 +460,16 @@ module.
Module.symvers contains a list of all exported symbols from a kernel Module.symvers contains a list of all exported symbols from a kernel
build. build.
--- 6.1 Symbols From the Kernel (vmlinux + modules) 6.1 Symbols From the Kernel (vmlinux + modules)
-----------------------------------------------
During a kernel build, a file named Module.symvers will be During a kernel build, a file named Module.symvers will be
generated. Module.symvers contains all exported symbols from generated. Module.symvers contains all exported symbols from
the kernel and compiled modules. For each symbol, the the kernel and compiled modules. For each symbol, the
corresponding CRC value is also stored. corresponding CRC value is also stored.
The syntax of the Module.symvers file is: The syntax of the Module.symvers file is::
<CRC> <Symbol> <module> <CRC> <Symbol> <module>
0x2d036834 scsi_remove_host drivers/scsi/scsi_mod 0x2d036834 scsi_remove_host drivers/scsi/scsi_mod
@ -451,10 +478,12 @@ build.
would read 0x00000000. would read 0x00000000.
Module.symvers serves two purposes: Module.symvers serves two purposes:
1) It lists all exported symbols from vmlinux and all modules. 1) It lists all exported symbols from vmlinux and all modules.
2) It lists the CRC if CONFIG_MODVERSIONS is enabled. 2) It lists the CRC if CONFIG_MODVERSIONS is enabled.
--- 6.2 Symbols and External Modules 6.2 Symbols and External Modules
--------------------------------
When building an external module, the build system needs access When building an external module, the build system needs access
to the symbols from the kernel to check if all external symbols to the symbols from the kernel to check if all external symbols
@ -481,17 +510,17 @@ build.
foo.ko needs symbols from bar.ko, you can use a foo.ko needs symbols from bar.ko, you can use a
common top-level kbuild file so both modules are common top-level kbuild file so both modules are
compiled in the same build. Consider the following compiled in the same build. Consider the following
directory layout: directory layout::
./foo/ <= contains foo.ko ./foo/ <= contains foo.ko
./bar/ <= contains bar.ko ./bar/ <= contains bar.ko
The top-level kbuild file would then look like: The top-level kbuild file would then look like::
#./Kbuild (or ./Makefile): #./Kbuild (or ./Makefile):
obj-y := foo/ bar/ obj-y := foo/ bar/
And executing And executing::
$ make -C $KDIR M=$PWD $ make -C $KDIR M=$PWD
@ -518,14 +547,16 @@ build.
initialization of its symbol tables. initialization of its symbol tables.
=== 7. Tips & Tricks 7. Tips & Tricks
================
--- 7.1 Testing for CONFIG_FOO_BAR 7.1 Testing for CONFIG_FOO_BAR
------------------------------
Modules often need to check for certain CONFIG_ options to Modules often need to check for certain `CONFIG_` options to
decide if a specific feature is included in the module. In decide if a specific feature is included in the module. In
kbuild this is done by referencing the CONFIG_ variable kbuild this is done by referencing the `CONFIG_` variable
directly. directly::
#fs/ext2/Makefile #fs/ext2/Makefile
obj-$(CONFIG_EXT2_FS) += ext2.o obj-$(CONFIG_EXT2_FS) += ext2.o
@ -534,8 +565,7 @@ build.
ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o ext2-$(CONFIG_EXT2_FS_XATTR) += xattr.o
External modules have traditionally used "grep" to check for External modules have traditionally used "grep" to check for
specific CONFIG_ settings directly in .config. This usage is specific `CONFIG_` settings directly in .config. This usage is
broken. As introduced before, external modules should use broken. As introduced before, external modules should use
kbuild for building and can therefore use the same methods as kbuild for building and can therefore use the same methods as
in-tree modules when testing for CONFIG_ definitions. in-tree modules when testing for `CONFIG_` definitions.

4
Documentation/kernel-hacking/hacking.rst
View File

@ -718,7 +718,7 @@ make a neat patch, there's administrative work to be done:
- Usually you want a configuration option for your kernel hack. Edit - Usually you want a configuration option for your kernel hack. Edit
``Kconfig`` in the appropriate directory. The Config language is ``Kconfig`` in the appropriate directory. The Config language is
simple to use by cut and paste, and there's complete documentation in simple to use by cut and paste, and there's complete documentation in
``Documentation/kbuild/kconfig-language.txt``. ``Documentation/kbuild/kconfig-language.rst``.
In your description of the option, make sure you address both the In your description of the option, make sure you address both the
expert user and the user who knows nothing about your feature. expert user and the user who knows nothing about your feature.
@ -728,7 +728,7 @@ make a neat patch, there's administrative work to be done:
- Edit the ``Makefile``: the CONFIG variables are exported here so you - Edit the ``Makefile``: the CONFIG variables are exported here so you
can usually just add a "obj-$(CONFIG_xxx) += xxx.o" line. The syntax can usually just add a "obj-$(CONFIG_xxx) += xxx.o" line. The syntax
is documented in ``Documentation/kbuild/makefiles.txt``. is documented in ``Documentation/kbuild/makefiles.rst``.
- Put yourself in ``CREDITS`` if you've done something noteworthy, - Put yourself in ``CREDITS`` if you've done something noteworthy,
usually beyond a single file (your name should be at the top of the usually beyond a single file (your name should be at the top of the

2
Documentation/process/coding-style.rst
View File

@ -686,7 +686,7 @@ filesystems) should advertise this prominently in their prompt string::
... ...
For full documentation on the configuration files, see the file For full documentation on the configuration files, see the file
Documentation/kbuild/kconfig-language.txt. Documentation/kbuild/kconfig-language.rst.
11) Data structures 11) Data structures

2
Documentation/process/submit-checklist.rst
View File

@ -39,7 +39,7 @@ and elsewhere regarding submitting Linux kernel patches.
6) Any new or modified ``CONFIG`` options do not muck up the config menu and 6) Any new or modified ``CONFIG`` options do not muck up the config menu and
default to off unless they meet the exception criteria documented in default to off unless they meet the exception criteria documented in
``Documentation/kbuild/kconfig-language.txt`` Menu attributes: default value. ``Documentation/kbuild/kconfig-language.rst`` Menu attributes: default value.
7) All new ``Kconfig`` options have help text. 7) All new ``Kconfig`` options have help text.

4
Documentation/translations/it_IT/kernel-hacking/hacking.rst
View File

@ -755,7 +755,7 @@ anche per avere patch pulite, c'è del lavoro amministrativo da fare:
- Solitamente vorrete un'opzione di configurazione per la vostra modifica - Solitamente vorrete un'opzione di configurazione per la vostra modifica
al kernel. Modificate ``Kconfig`` nella cartella giusta. Il linguaggio al kernel. Modificate ``Kconfig`` nella cartella giusta. Il linguaggio
Config è facile con copia ed incolla, e c'è una completa documentazione Config è facile con copia ed incolla, e c'è una completa documentazione
nel file ``Documentation/kbuild/kconfig-language.txt``. nel file ``Documentation/kbuild/kconfig-language.rst``.
Nella descrizione della vostra opzione, assicuratevi di parlare sia agli Nella descrizione della vostra opzione, assicuratevi di parlare sia agli
utenti esperti sia agli utente che non sanno nulla del vostro lavoro. utenti esperti sia agli utente che non sanno nulla del vostro lavoro.
@ -767,7 +767,7 @@ anche per avere patch pulite, c'è del lavoro amministrativo da fare:
- Modificate il file ``Makefile``: le variabili CONFIG sono esportate qui, - Modificate il file ``Makefile``: le variabili CONFIG sono esportate qui,
quindi potete solitamente aggiungere una riga come la seguete quindi potete solitamente aggiungere una riga come la seguete
"obj-$(CONFIG_xxx) += xxx.o". La sintassi è documentata nel file "obj-$(CONFIG_xxx) += xxx.o". La sintassi è documentata nel file
``Documentation/kbuild/makefiles.txt``. ``Documentation/kbuild/makefiles.rst``.
- Aggiungete voi stessi in ``CREDITS`` se avete fatto qualcosa di notevole, - Aggiungete voi stessi in ``CREDITS`` se avete fatto qualcosa di notevole,
solitamente qualcosa che supera il singolo file (comunque il vostro nome solitamente qualcosa che supera il singolo file (comunque il vostro nome

2
Documentation/translations/it_IT/process/coding-style.rst
View File

@ -696,7 +696,7 @@ nella stringa di titolo::
... ...
Per la documentazione completa sui file di configurazione, consultate Per la documentazione completa sui file di configurazione, consultate
il documento Documentation/kbuild/kconfig-language.txt il documento Documentation/kbuild/kconfig-language.rst
11) Strutture dati 11) Strutture dati

2
Documentation/translations/it_IT/process/submit-checklist.rst
View File

@ -43,7 +43,7 @@ sottomissione delle patch, in particolare
6) Le opzioni ``CONFIG``, nuove o modificate, non scombussolano il menu 6) Le opzioni ``CONFIG``, nuove o modificate, non scombussolano il menu
di configurazione e sono preimpostate come disabilitate a meno che non di configurazione e sono preimpostate come disabilitate a meno che non
soddisfino i criteri descritti in ``Documentation/kbuild/kconfig-language.txt`` soddisfino i criteri descritti in ``Documentation/kbuild/kconfig-language.rst``
alla punto "Voci di menu: valori predefiniti". alla punto "Voci di menu: valori predefiniti".
7) Tutte le nuove opzioni ``Kconfig`` hanno un messaggio di aiuto. 7) Tutte le nuove opzioni ``Kconfig`` hanno un messaggio di aiuto.

2
Documentation/translations/zh_CN/process/coding-style.rst
View File

@ -599,7 +599,7 @@ Documentation/doc-guide/ 和 scripts/kernel-doc 以获得详细信息。
depends on ADFS_FS depends on ADFS_FS
... ...
要查看配置文件的完整文档，请看 Documentation/kbuild/kconfig-language.txt。 要查看配置文件的完整文档，请看 Documentation/kbuild/kconfig-language.rst。
11) 数据结构 11) 数据结构

2
Documentation/translations/zh_CN/process/submit-checklist.rst
View File

@ -38,7 +38,7 @@ Linux内核补丁提交清单
违规行为。 违规行为。
6) 任何新的或修改过的 ``CONFIG`` 选项都不会弄脏配置菜单，并默认为关闭，除非 6) 任何新的或修改过的 ``CONFIG`` 选项都不会弄脏配置菜单，并默认为关闭，除非
它们符合 ``Documentation/kbuild/kconfig-language.txt`` 中记录的异常条件, 它们符合 ``Documentation/kbuild/kconfig-language.rst`` 中记录的异常条件,
菜单属性：默认值. 菜单属性：默认值.
7) 所有新的 ``kconfig`` 选项都有帮助文本。 7) 所有新的 ``kconfig`` 选项都有帮助文本。

2
Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
mainmenu "Linux/$(ARCH) $(KERNELVERSION) Kernel Configuration" mainmenu "Linux/$(ARCH) $(KERNELVERSION) Kernel Configuration"

2
arch/arc/plat-eznps/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
menuconfig ARC_PLAT_EZNPS menuconfig ARC_PLAT_EZNPS

2
arch/c6x/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
config C6X config C6X

2
arch/microblaze/Kconfig.debug
View File

@ -1,6 +1,6 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
config TRACE_IRQFLAGS_SUPPORT config TRACE_IRQFLAGS_SUPPORT
def_bool y def_bool y

2
arch/microblaze/Kconfig.platform
View File

@ -1,6 +1,6 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
# Platform selection Kconfig menu for MicroBlaze targets # Platform selection Kconfig menu for MicroBlaze targets
# #

2
arch/nds32/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
config NDS32 config NDS32

2
arch/openrisc/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
config OPENRISC config OPENRISC

2
arch/powerpc/sysdev/Kconfig
View File

@ -1,6 +1,6 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
config PPC4xx_PCI_EXPRESS config PPC4xx_PCI_EXPRESS

2
arch/riscv/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
config 64BIT config 64BIT

2
drivers/auxdisplay/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0 # SPDX-License-Identifier: GPL-2.0
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
# Auxiliary display drivers configuration. # Auxiliary display drivers configuration.
# #

2
drivers/firmware/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
menu "Firmware Drivers" menu "Firmware Drivers"

2
drivers/mtd/devices/Kconfig
View File

@ -48,7 +48,7 @@ config MTD_MS02NV
If you want to compile this driver as a module ( = code which can be If you want to compile this driver as a module ( = code which can be
inserted in and removed from the running kernel whenever you want), inserted in and removed from the running kernel whenever you want),
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
The module will be called ms02-nv. The module will be called ms02-nv.
config MTD_DATAFLASH config MTD_DATAFLASH

6
drivers/net/ethernet/smsc/Kconfig
View File

@ -49,7 +49,7 @@ config SMC91X
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you want). inserted in and removed from the running kernel whenever you want).
The module will be called smc91x. If you want to compile it as a The module will be called smc91x. If you want to compile it as a
module, say M here and read <file:Documentation/kbuild/modules.txt>. module, say M here and read <file:Documentation/kbuild/modules.rst>.
config PCMCIA_SMC91C92 config PCMCIA_SMC91C92
tristate "SMC 91Cxx PCMCIA support" tristate "SMC 91Cxx PCMCIA support"
@ -86,7 +86,7 @@ config SMC911X
This driver is also available as a module. The module will be This driver is also available as a module. The module will be
called smc911x. If you want to compile it as a module, say M called smc911x. If you want to compile it as a module, say M
here and read <file:Documentation/kbuild/modules.txt> here and read <file:Documentation/kbuild/modules.rst>
config SMSC911X config SMSC911X
tristate "SMSC LAN911x/LAN921x families embedded ethernet support" tristate "SMSC LAN911x/LAN921x families embedded ethernet support"
@ -121,6 +121,6 @@ config SMSC9420
This driver is also available as a module. The module will be This driver is also available as a module. The module will be
called smsc9420. If you want to compile it as a module, say M called smsc9420. If you want to compile it as a module, say M
here and read <file:Documentation/kbuild/modules.txt> here and read <file:Documentation/kbuild/modules.rst>
endif # NET_VENDOR_SMSC endif # NET_VENDOR_SMSC

4
drivers/net/wireless/intel/iwlegacy/Kconfig
View File

@ -32,7 +32,7 @@ config IWL4965
If you want to compile the driver as a module ( = code which can be If you want to compile the driver as a module ( = code which can be
inserted in and removed from the running kernel whenever you want), inserted in and removed from the running kernel whenever you want),
say M here and read <file:Documentation/kbuild/modules.txt>. The say M here and read <file:Documentation/kbuild/modules.rst>. The
module will be called iwl4965. module will be called iwl4965.
config IWL3945 config IWL3945
@ -58,7 +58,7 @@ config IWL3945
If you want to compile the driver as a module ( = code which can be If you want to compile the driver as a module ( = code which can be
inserted in and removed from the running kernel whenever you want), inserted in and removed from the running kernel whenever you want),
say M here and read <file:Documentation/kbuild/modules.txt>. The say M here and read <file:Documentation/kbuild/modules.rst>. The
module will be called iwl3945. module will be called iwl3945.
menu "iwl3945 / iwl4965 Debugging Options" menu "iwl3945 / iwl4965 Debugging Options"

2
drivers/net/wireless/intel/iwlwifi/Kconfig
View File

@ -40,7 +40,7 @@ config IWLWIFI
If you want to compile the driver as a module ( = code which can be If you want to compile the driver as a module ( = code which can be
inserted in and removed from the running kernel whenever you want), inserted in and removed from the running kernel whenever you want),
say M here and read <file:Documentation/kbuild/modules.txt>. The say M here and read <file:Documentation/kbuild/modules.rst>. The
module will be called iwlwifi. module will be called iwlwifi.
if IWLWIFI if IWLWIFI

2
drivers/parport/Kconfig
View File

@ -1,7 +1,7 @@
# SPDX-License-Identifier: GPL-2.0-only # SPDX-License-Identifier: GPL-2.0-only
# #
# For a description of the syntax of this configuration file, # For a description of the syntax of this configuration file,
# see Documentation/kbuild/kconfig-language.txt. # see Documentation/kbuild/kconfig-language.rst.
# #
# Parport configuration. # Parport configuration.
# #

4
drivers/scsi/Kconfig
View File

@ -183,7 +183,7 @@ config CHR_DEV_SCH
If you want to compile this as a module ( = code which can be If you want to compile this as a module ( = code which can be
inserted in and removed from the running kernel whenever you want), inserted in and removed from the running kernel whenever you want),
say M here and read <file:Documentation/kbuild/modules.txt> and say M here and read <file:Documentation/kbuild/modules.rst> and
<file:Documentation/scsi/scsi.txt>. The module will be called ch.o. <file:Documentation/scsi/scsi.txt>. The module will be called ch.o.
If unsure, say N. If unsure, say N.
@ -1474,7 +1474,7 @@ config ZFCP
This driver is also available as a module. This module will be This driver is also available as a module. This module will be
called zfcp. If you want to compile it as a module, say M here called zfcp. If you want to compile it as a module, say M here
and read <file:Documentation/kbuild/modules.txt>. and read <file:Documentation/kbuild/modules.rst>.
config SCSI_PMCRAID config SCSI_PMCRAID
tristate "PMC SIERRA Linux MaxRAID adapter support" tristate "PMC SIERRA Linux MaxRAID adapter support"

2
drivers/staging/sm750fb/Kconfig
View File

@ -12,4 +12,4 @@ config FB_SM750
This driver is also available as a module. The module will be This driver is also available as a module. The module will be
called sm750fb. If you want to compile it as a module, say M called sm750fb. If you want to compile it as a module, say M
here and read <file:Documentation/kbuild/modules.txt>. here and read <file:Documentation/kbuild/modules.rst>.

4
drivers/usb/misc/Kconfig
View File

@ -16,7 +16,7 @@ config USB_EMI62
This code is also available as a module ( = code which can be This code is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you want). inserted in and removed from the running kernel whenever you want).
The module will be called audio. If you want to compile it as a The module will be called audio. If you want to compile it as a
module, say M here and read <file:Documentation/kbuild/modules.txt>. module, say M here and read <file:Documentation/kbuild/modules.rst>.
config USB_EMI26 config USB_EMI26
tristate "EMI 2|6 USB Audio interface support" tristate "EMI 2|6 USB Audio interface support"
@ -67,7 +67,7 @@ config USB_LEGOTOWER
inserted in and removed from the running kernel whenever you want). inserted in and removed from the running kernel whenever you want).
The module will be called legousbtower. If you want to compile it as The module will be called legousbtower. If you want to compile it as
a module, say M here and read a module, say M here and read
<file:Documentation/kbuild/modules.txt>. <file:Documentation/kbuild/modules.rst>.
config USB_LCD config USB_LCD
tristate "USB LCD driver support" tristate "USB LCD driver support"

14
drivers/video/fbdev/Kconfig
View File

@ -289,7 +289,7 @@ config FB_ARMCLCD
If you want to compile this as a module (=code which can be If you want to compile this as a module (=code which can be
inserted into and removed from the running kernel), say M inserted into and removed from the running kernel), say M
here and read <file:Documentation/kbuild/modules.txt>. The module here and read <file:Documentation/kbuild/modules.rst>. The module
will be called amba-clcd. will be called amba-clcd.
config FB_ACORN config FB_ACORN
@ -1752,7 +1752,7 @@ config FB_PXA
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted and removed from the running kernel whenever you want). The inserted and removed from the running kernel whenever you want). The
module will be called pxafb. If you want to compile it as a module, module will be called pxafb. If you want to compile it as a module,
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
If unsure, say N. If unsure, say N.
@ -1833,7 +1833,7 @@ config FB_W100
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted and removed from the running kernel whenever you want). The inserted and removed from the running kernel whenever you want). The
module will be called w100fb. If you want to compile it as a module, module will be called w100fb. If you want to compile it as a module,
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
If unsure, say N. If unsure, say N.
@ -1862,7 +1862,7 @@ config FB_TMIO
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted and removed from the running kernel whenever you want). The inserted and removed from the running kernel whenever you want). The
module will be called tmiofb. If you want to compile it as a module, module will be called tmiofb. If you want to compile it as a module,
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
If unsure, say N. If unsure, say N.
@ -1908,7 +1908,7 @@ config FB_S3C2410
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted and removed from the running kernel whenever you want). The inserted and removed from the running kernel whenever you want). The
module will be called s3c2410fb. If you want to compile it as a module, module will be called s3c2410fb. If you want to compile it as a module,
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
If unsure, say N. If unsure, say N.
config FB_S3C2410_DEBUG config FB_S3C2410_DEBUG
@ -1945,7 +1945,7 @@ config FB_SM501
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted and removed from the running kernel whenever you want). The inserted and removed from the running kernel whenever you want). The
module will be called sm501fb. If you want to compile it as a module, module will be called sm501fb. If you want to compile it as a module,
say M here and read <file:Documentation/kbuild/modules.txt>. say M here and read <file:Documentation/kbuild/modules.rst>.
If unsure, say N. If unsure, say N.
@ -2288,7 +2288,7 @@ config FB_SM712
This driver is also available as a module. The module will be This driver is also available as a module. The module will be
called sm712fb. If you want to compile it as a module, say M called sm712fb. If you want to compile it as a module, say M
here and read <file:Documentation/kbuild/modules.txt>. here and read <file:Documentation/kbuild/modules.rst>.
source "drivers/video/fbdev/omap/Kconfig" source "drivers/video/fbdev/omap/Kconfig"
source "drivers/video/fbdev/omap2/Kconfig" source "drivers/video/fbdev/omap2/Kconfig"

2
net/bridge/netfilter/Kconfig
View File

@ -114,7 +114,7 @@ config BRIDGE_EBT_LIMIT
equivalent of the iptables limit match. equivalent of the iptables limit match.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config BRIDGE_EBT_MARK config BRIDGE_EBT_MARK
tristate "ebt: mark filter support" tristate "ebt: mark filter support"

2
net/ipv4/netfilter/Kconfig
View File

@ -308,7 +308,7 @@ config IP_NF_RAW
and OUTPUT chains. and OUTPUT chains.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
# security table for MAC policy # security table for MAC policy
config IP_NF_SECURITY config IP_NF_SECURITY

2
net/ipv6/netfilter/Kconfig
View File

@ -241,7 +241,7 @@ config IP6_NF_RAW
and OUTPUT chains. and OUTPUT chains.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
# security table for MAC policy # security table for MAC policy
config IP6_NF_SECURITY config IP6_NF_SECURITY

16
net/netfilter/Kconfig
View File

@ -1056,7 +1056,7 @@ config NETFILTER_XT_TARGET_TRACE
the tables, chains, rules. the tables, chains, rules.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_TARGET_SECMARK config NETFILTER_XT_TARGET_SECMARK
tristate '"SECMARK" target support' tristate '"SECMARK" target support'
@ -1115,7 +1115,7 @@ config NETFILTER_XT_MATCH_ADDRTYPE
eg. UNICAST, LOCAL, BROADCAST, ... eg. UNICAST, LOCAL, BROADCAST, ...
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_BPF config NETFILTER_XT_MATCH_BPF
tristate '"bpf" match support' tristate '"bpf" match support'
@ -1160,7 +1160,7 @@ config NETFILTER_XT_MATCH_COMMENT
comments in your iptables ruleset. comments in your iptables ruleset.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_CONNBYTES config NETFILTER_XT_MATCH_CONNBYTES
tristate '"connbytes" per-connection counter match support' tristate '"connbytes" per-connection counter match support'
@ -1171,7 +1171,7 @@ config NETFILTER_XT_MATCH_CONNBYTES
number of bytes and/or packets for each direction within a connection. number of bytes and/or packets for each direction within a connection.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_CONNLABEL config NETFILTER_XT_MATCH_CONNLABEL
tristate '"connlabel" match support' tristate '"connlabel" match support'
@ -1237,7 +1237,7 @@ config NETFILTER_XT_MATCH_DCCP
and DCCP flags. and DCCP flags.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_DEVGROUP config NETFILTER_XT_MATCH_DEVGROUP
tristate '"devgroup" match support' tristate '"devgroup" match support'
@ -1473,7 +1473,7 @@ config NETFILTER_XT_MATCH_QUOTA
byte counter. byte counter.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_RATEEST config NETFILTER_XT_MATCH_RATEEST
tristate '"rateest" match support' tristate '"rateest" match support'
@ -1497,7 +1497,7 @@ config NETFILTER_XT_MATCH_REALM
in tc world. in tc world.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_RECENT config NETFILTER_XT_MATCH_RECENT
tristate '"recent" match support' tristate '"recent" match support'
@ -1519,7 +1519,7 @@ config NETFILTER_XT_MATCH_SCTP
and SCTP chunk types. and SCTP chunk types.
If you want to compile it as a module, say M here and read If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. If unsure, say `N'. <file:Documentation/kbuild/modules.rst>. If unsure, say `N'.
config NETFILTER_XT_MATCH_SOCKET config NETFILTER_XT_MATCH_SOCKET
tristate '"socket" match support' tristate '"socket" match support'

2
net/tipc/Kconfig
View File

@ -17,7 +17,7 @@ menuconfig TIPC
This protocol support is also available as a module ( = code which This protocol support is also available as a module ( = code which
can be inserted in and removed from the running kernel whenever you can be inserted in and removed from the running kernel whenever you
want). The module will be called tipc. If you want to compile it want). The module will be called tipc. If you want to compile it
as a module, say M here and read <file:Documentation/kbuild/modules.txt>. as a module, say M here and read <file:Documentation/kbuild/modules.rst>.
If in doubt, say N. If in doubt, say N.

4
scripts/Kbuild.include
View File

@ -68,7 +68,7 @@ endef
###### ######
# gcc support functions # gcc support functions
# See documentation in Documentation/kbuild/makefiles.txt # See documentation in Documentation/kbuild/makefiles.rst
# cc-cross-prefix # cc-cross-prefix
# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-) # Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
@ -210,7 +210,7 @@ objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies # if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
# including used config symbols # including used config symbols
# if_changed_rule - as if_changed but execute rule instead # if_changed_rule - as if_changed but execute rule instead
# See Documentation/kbuild/makefiles.txt for more info # See Documentation/kbuild/makefiles.rst for more info
ifneq ($(KBUILD_NOCMDDEP),1) ifneq ($(KBUILD_NOCMDDEP),1)
# Check if both arguments are the same including their order. Result is empty # Check if both arguments are the same including their order. Result is empty

2
scripts/Makefile.host
View File

@ -6,7 +6,7 @@
# #
# Both C and C++ are supported, but preferred language is C for such utilities. # Both C and C++ are supported, but preferred language is C for such utilities.
# #
# Sample syntax (see Documentation/kbuild/makefiles.txt for reference) # Sample syntax (see Documentation/kbuild/makefiles.rst for reference)
# hostprogs-y := bin2hex # hostprogs-y := bin2hex
# Will compile bin2hex.c and create an executable named bin2hex # Will compile bin2hex.c and create an executable named bin2hex
# #

2
scripts/kconfig/symbol.c
View File

@ -1114,7 +1114,7 @@ static void sym_check_print_recursive(struct symbol *last_sym)
} }
fprintf(stderr, fprintf(stderr,
"For a resolution refer to Documentation/kbuild/kconfig-language.txt\n" "For a resolution refer to Documentation/kbuild/kconfig-language.rst\n"
"subsection \"Kconfig recursive dependency limitations\"\n" "subsection \"Kconfig recursive dependency limitations\"\n"
"\n"); "\n");

14
scripts/kconfig/tests/err_recursive_dep/expected_stderr
View File

@ -1,38 +1,38 @@
Kconfig:11:error: recursive dependency detected! Kconfig:11:error: recursive dependency detected!
Kconfig:11: symbol B is selected by B Kconfig:11: symbol B is selected by B
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:5:error: recursive dependency detected! Kconfig:5:error: recursive dependency detected!
Kconfig:5: symbol A depends on A Kconfig:5: symbol A depends on A
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:17:error: recursive dependency detected! Kconfig:17:error: recursive dependency detected!
Kconfig:17: symbol C1 depends on C2 Kconfig:17: symbol C1 depends on C2
Kconfig:21: symbol C2 depends on C1 Kconfig:21: symbol C2 depends on C1
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:32:error: recursive dependency detected! Kconfig:32:error: recursive dependency detected!
Kconfig:32: symbol D2 is selected by D1 Kconfig:32: symbol D2 is selected by D1
Kconfig:27: symbol D1 depends on D2 Kconfig:27: symbol D1 depends on D2
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:37:error: recursive dependency detected! Kconfig:37:error: recursive dependency detected!
Kconfig:37: symbol E1 depends on E2 Kconfig:37: symbol E1 depends on E2
Kconfig:42: symbol E2 is implied by E1 Kconfig:42: symbol E2 is implied by E1
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:60:error: recursive dependency detected! Kconfig:60:error: recursive dependency detected!
Kconfig:60: symbol G depends on G Kconfig:60: symbol G depends on G
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"
Kconfig:51:error: recursive dependency detected! Kconfig:51:error: recursive dependency detected!
Kconfig:51: symbol F2 depends on F1 Kconfig:51: symbol F2 depends on F1
Kconfig:49: symbol F1 default value contains F2 Kconfig:49: symbol F1 default value contains F2
For a resolution refer to Documentation/kbuild/kconfig-language.txt For a resolution refer to Documentation/kbuild/kconfig-language.rst
subsection "Kconfig recursive dependency limitations" subsection "Kconfig recursive dependency limitations"

6
sound/oss/dmasound/Kconfig
View File

@ -11,7 +11,7 @@ config DMASOUND_ATARI
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you inserted in and removed from the running kernel whenever you
want). If you want to compile it as a module, say M here and read want). If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. <file:Documentation/kbuild/modules.rst>.
config DMASOUND_PAULA config DMASOUND_PAULA
tristate "Amiga DMA sound support" tristate "Amiga DMA sound support"
@ -25,7 +25,7 @@ config DMASOUND_PAULA
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you inserted in and removed from the running kernel whenever you
want). If you want to compile it as a module, say M here and read want). If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. <file:Documentation/kbuild/modules.rst>.
config DMASOUND_Q40 config DMASOUND_Q40
tristate "Q40 sound support" tristate "Q40 sound support"
@ -39,7 +39,7 @@ config DMASOUND_Q40
This driver is also available as a module ( = code which can be This driver is also available as a module ( = code which can be
inserted in and removed from the running kernel whenever you inserted in and removed from the running kernel whenever you
want). If you want to compile it as a module, say M here and read want). If you want to compile it as a module, say M here and read
<file:Documentation/kbuild/modules.txt>. <file:Documentation/kbuild/modules.rst>.
config DMASOUND config DMASOUND
tristate tristate