Skip to content
Snippets Groups Projects
Commit cd238eff authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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


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: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent d7b461c5
No related branches found
No related tags found
No related merge requests found
...@@ -241,7 +241,7 @@ config IP6_NF_RAW ...@@ -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
......
...@@ -1056,7 +1056,7 @@ config NETFILTER_XT_TARGET_TRACE ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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'
......
...@@ -17,7 +17,7 @@ menuconfig TIPC ...@@ -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.
......
...@@ -68,7 +68,7 @@ endef ...@@ -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))) ...@@ -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
......
...@@ -6,7 +6,7 @@ ...@@ -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
# #
......
...@@ -1114,7 +1114,7 @@ static void sym_check_print_recursive(struct symbol *last_sym) ...@@ -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");
......
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"
...@@ -11,7 +11,7 @@ config DMASOUND_ATARI ...@@ -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 ...@@ -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 ...@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment