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.

Mauro Carvalho Chehab committed 7 years ago

Commit cd238ef1 parent d7b461c48 files · +846 −567Browse files

Showing the changes to scripts (4 of 48 files). Show all

Unified · Split

4 files

scripts/Kbuild.include +2 −2
scripts/Makefile.host +1 −1
scripts/kconfig/symbol.c +1 −1
scripts/kconfig/tests/err_recursive_dep/expected_stderr +7 −7

scripts/Kbuild.include+2−2

@@ -68,7 +68,7 @@ endef · 67 unmodified lines
68		68
69	######	69	######
70	# gcc support functions	70	# gcc support functions
71	# See documentation in Documentation/kbuild/makefiles.txt	71	# See documentation in Documentation/kbuild/makefiles.rst
72		72
73	# cc-cross-prefix	73	# cc-cross-prefix
74	# Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)	74	# 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))) · 135 unmodified lines
210	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies	210	# if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
211	# including used config symbols	211	# including used config symbols
212	# if_changed_rule - as if_changed but execute rule instead	212	# if_changed_rule - as if_changed but execute rule instead
213	# See Documentation/kbuild/makefiles.txt for more info	213	# See Documentation/kbuild/makefiles.rst for more info
214		214
215	ifneq ($(KBUILD_NOCMDDEP),1)	215	ifneq ($(KBUILD_NOCMDDEP),1)
216	# Check if both arguments are the same including their order. Result is empty	216	# Check if both arguments are the same including their order. Result is empty

scripts/Makefile.host+1−1

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

scripts/kconfig/symbol.c+1−1

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

scripts/kconfig/tests/err_recursive_dep/expected_stderr+7−7

@@ -1,38 +1,38 @@
1	Kconfig:11:error: recursive dependency detected!	1	Kconfig:11:error: recursive dependency detected!
2	Kconfig:11: symbol B is selected by B	2	Kconfig:11: symbol B is selected by B
3	For a resolution refer to Documentation/kbuild/kconfig-language.txt	3	For a resolution refer to Documentation/kbuild/kconfig-language.rst
4	subsection "Kconfig recursive dependency limitations"	4	subsection "Kconfig recursive dependency limitations"
5		5
6	Kconfig:5:error: recursive dependency detected!	6	Kconfig:5:error: recursive dependency detected!
7	Kconfig:5: symbol A depends on A	7	Kconfig:5: symbol A depends on A
8	For a resolution refer to Documentation/kbuild/kconfig-language.txt	8	For a resolution refer to Documentation/kbuild/kconfig-language.rst
9	subsection "Kconfig recursive dependency limitations"	9	subsection "Kconfig recursive dependency limitations"
10		10
11	Kconfig:17:error: recursive dependency detected!	11	Kconfig:17:error: recursive dependency detected!
12	Kconfig:17: symbol C1 depends on C2	12	Kconfig:17: symbol C1 depends on C2
13	Kconfig:21: symbol C2 depends on C1	13	Kconfig:21: symbol C2 depends on C1
14	For a resolution refer to Documentation/kbuild/kconfig-language.txt	14	For a resolution refer to Documentation/kbuild/kconfig-language.rst
15	subsection "Kconfig recursive dependency limitations"	15	subsection "Kconfig recursive dependency limitations"
16		16
17	Kconfig:32:error: recursive dependency detected!	17	Kconfig:32:error: recursive dependency detected!
18	Kconfig:32: symbol D2 is selected by D1	18	Kconfig:32: symbol D2 is selected by D1
19	Kconfig:27: symbol D1 depends on D2	19	Kconfig:27: symbol D1 depends on D2
20	For a resolution refer to Documentation/kbuild/kconfig-language.txt	20	For a resolution refer to Documentation/kbuild/kconfig-language.rst
21	subsection "Kconfig recursive dependency limitations"	21	subsection "Kconfig recursive dependency limitations"
22		22
23	Kconfig:37:error: recursive dependency detected!	23	Kconfig:37:error: recursive dependency detected!
24	Kconfig:37: symbol E1 depends on E2	24	Kconfig:37: symbol E1 depends on E2
25	Kconfig:42: symbol E2 is implied by E1	25	Kconfig:42: symbol E2 is implied by E1
26	For a resolution refer to Documentation/kbuild/kconfig-language.txt	26	For a resolution refer to Documentation/kbuild/kconfig-language.rst
27	subsection "Kconfig recursive dependency limitations"	27	subsection "Kconfig recursive dependency limitations"
28		28
29	Kconfig:60:error: recursive dependency detected!	29	Kconfig:60:error: recursive dependency detected!
30	Kconfig:60: symbol G depends on G	30	Kconfig:60: symbol G depends on G
31	For a resolution refer to Documentation/kbuild/kconfig-language.txt	31	For a resolution refer to Documentation/kbuild/kconfig-language.rst
32	subsection "Kconfig recursive dependency limitations"	32	subsection "Kconfig recursive dependency limitations"
33		33
34	Kconfig:51:error: recursive dependency detected!	34	Kconfig:51:error: recursive dependency detected!
35	Kconfig:51: symbol F2 depends on F1	35	Kconfig:51: symbol F2 depends on F1
36	Kconfig:49: symbol F1 default value contains F2	36	Kconfig:49: symbol F1 default value contains F2
37	For a resolution refer to Documentation/kbuild/kconfig-language.txt	37	For a resolution refer to Documentation/kbuild/kconfig-language.rst
38	subsection "Kconfig recursive dependency limitations"	38	subsection "Kconfig recursive dependency limitations"