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
Showing
with 31 additions and 31 deletions
# 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
......
# 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
# 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
# #
......
# 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
......
# 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
......
# 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
......
# 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
......
# 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.
# #
......
# 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"
......
...@@ -48,7 +48,7 @@ config MTD_MS02NV ...@@ -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
......
...@@ -49,7 +49,7 @@ config SMC91X ...@@ -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 ...@@ -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 ...@@ -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
...@@ -32,7 +32,7 @@ config IWL4965 ...@@ -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 ...@@ -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"
......
...@@ -40,7 +40,7 @@ config IWLWIFI ...@@ -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
......
# 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.
# #
......
...@@ -183,7 +183,7 @@ config CHR_DEV_SCH ...@@ -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 ...@@ -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"
......
...@@ -12,4 +12,4 @@ config FB_SM750 ...@@ -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>.
...@@ -16,7 +16,7 @@ config USB_EMI62 ...@@ -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 ...@@ -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"
......
...@@ -289,7 +289,7 @@ config FB_ARMCLCD ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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 ...@@ -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"
......
...@@ -114,7 +114,7 @@ config BRIDGE_EBT_LIMIT ...@@ -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"
......
...@@ -308,7 +308,7 @@ config IP_NF_RAW ...@@ -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
......
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