diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-13 06:50:43 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 07:44:18 -0400 |
commit | bffac837f3a385e08e9252e9089dc98741743f25 (patch) | |
tree | a5c0fc66f1f34b03e49d77d793b6faeab4281696 /Documentation | |
parent | b6f6c29454d236e85f2912cb0f9366825ca1b0be (diff) |
docs-rst: convert sh book to ReST
Use pandoc to convert documentation to ReST by calling
Documentation/sphinx/tmplcvt script.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/DocBook/Makefile | 4 | ||||
-rw-r--r-- | Documentation/DocBook/sh.tmpl | 105 | ||||
-rw-r--r-- | Documentation/conf.py | 2 | ||||
-rw-r--r-- | Documentation/index.rst | 11 | ||||
-rw-r--r-- | Documentation/sh/conf.py | 10 | ||||
-rw-r--r-- | Documentation/sh/index.rst | 59 |
6 files changed, 83 insertions, 108 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 226e5e9fc801..efba7f980895 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -6,9 +6,7 @@ | |||
6 | # To add a new book the only step required is to add the book to the | 6 | # To add a new book the only step required is to add the book to the |
7 | # list of DOCBOOKS. | 7 | # list of DOCBOOKS. |
8 | 8 | ||
9 | DOCBOOKS := \ | 9 | DOCBOOKS := lsm.xml |
10 | lsm.xml \ | ||
11 | sh.xml | ||
12 | 10 | ||
13 | ifeq ($(DOCBOOKS),) | 11 | ifeq ($(DOCBOOKS),) |
14 | 12 | ||
diff --git a/Documentation/DocBook/sh.tmpl b/Documentation/DocBook/sh.tmpl deleted file mode 100644 index 4a38f604fa66..000000000000 --- a/Documentation/DocBook/sh.tmpl +++ /dev/null | |||
@@ -1,105 +0,0 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | ||
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> | ||
4 | |||
5 | <book id="sh-drivers"> | ||
6 | <bookinfo> | ||
7 | <title>SuperH Interfaces Guide</title> | ||
8 | |||
9 | <authorgroup> | ||
10 | <author> | ||
11 | <firstname>Paul</firstname> | ||
12 | <surname>Mundt</surname> | ||
13 | <affiliation> | ||
14 | <address> | ||
15 | <email>lethal@linux-sh.org</email> | ||
16 | </address> | ||
17 | </affiliation> | ||
18 | </author> | ||
19 | </authorgroup> | ||
20 | |||
21 | <copyright> | ||
22 | <year>2008-2010</year> | ||
23 | <holder>Paul Mundt</holder> | ||
24 | </copyright> | ||
25 | <copyright> | ||
26 | <year>2008-2010</year> | ||
27 | <holder>Renesas Technology Corp.</holder> | ||
28 | </copyright> | ||
29 | <copyright> | ||
30 | <year>2010</year> | ||
31 | <holder>Renesas Electronics Corp.</holder> | ||
32 | </copyright> | ||
33 | |||
34 | <legalnotice> | ||
35 | <para> | ||
36 | This documentation is free software; you can redistribute | ||
37 | it and/or modify it under the terms of the GNU General Public | ||
38 | License version 2 as published by the Free Software Foundation. | ||
39 | </para> | ||
40 | |||
41 | <para> | ||
42 | This program is distributed in the hope that it will be | ||
43 | useful, but WITHOUT ANY WARRANTY; without even the implied | ||
44 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
45 | See the GNU General Public License for more details. | ||
46 | </para> | ||
47 | |||
48 | <para> | ||
49 | You should have received a copy of the GNU General Public | ||
50 | License along with this program; if not, write to the Free | ||
51 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | ||
52 | MA 02111-1307 USA | ||
53 | </para> | ||
54 | |||
55 | <para> | ||
56 | For more details see the file COPYING in the source | ||
57 | distribution of Linux. | ||
58 | </para> | ||
59 | </legalnotice> | ||
60 | </bookinfo> | ||
61 | |||
62 | <toc></toc> | ||
63 | |||
64 | <chapter id="mm"> | ||
65 | <title>Memory Management</title> | ||
66 | <sect1 id="sh4"> | ||
67 | <title>SH-4</title> | ||
68 | <sect2 id="sq"> | ||
69 | <title>Store Queue API</title> | ||
70 | !Earch/sh/kernel/cpu/sh4/sq.c | ||
71 | </sect2> | ||
72 | </sect1> | ||
73 | <sect1 id="sh5"> | ||
74 | <title>SH-5</title> | ||
75 | <sect2 id="tlb"> | ||
76 | <title>TLB Interfaces</title> | ||
77 | !Iarch/sh/mm/tlb-sh5.c | ||
78 | !Iarch/sh/include/asm/tlb_64.h | ||
79 | </sect2> | ||
80 | </sect1> | ||
81 | </chapter> | ||
82 | <chapter id="mach"> | ||
83 | <title>Machine Specific Interfaces</title> | ||
84 | <sect1 id="dreamcast"> | ||
85 | <title>mach-dreamcast</title> | ||
86 | !Iarch/sh/boards/mach-dreamcast/rtc.c | ||
87 | </sect1> | ||
88 | <sect1 id="x3proto"> | ||
89 | <title>mach-x3proto</title> | ||
90 | !Earch/sh/boards/mach-x3proto/ilsel.c | ||
91 | </sect1> | ||
92 | </chapter> | ||
93 | <chapter id="busses"> | ||
94 | <title>Busses</title> | ||
95 | <sect1 id="superhyway"> | ||
96 | <title>SuperHyway</title> | ||
97 | !Edrivers/sh/superhyway/superhyway.c | ||
98 | </sect1> | ||
99 | |||
100 | <sect1 id="maple"> | ||
101 | <title>Maple</title> | ||
102 | !Edrivers/sh/maple/maple.c | ||
103 | </sect1> | ||
104 | </chapter> | ||
105 | </book> | ||
diff --git a/Documentation/conf.py b/Documentation/conf.py index dfe14f7525d0..77d47bb1df1d 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py | |||
@@ -375,6 +375,8 @@ latex_documents = [ | |||
375 | 'The kernel development community', 'manual'), | 375 | 'The kernel development community', 'manual'), |
376 | ('security/index', 'security.tex', 'The kernel security subsystem manual', | 376 | ('security/index', 'security.tex', 'The kernel security subsystem manual', |
377 | 'The kernel development community', 'manual'), | 377 | 'The kernel development community', 'manual'), |
378 | ('sh/index', 'sh.tex', 'SuperH architecture implementation manual', | ||
379 | 'The kernel development community', 'manual'), | ||
378 | ('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation', | 380 | ('sound/index', 'sound.tex', 'Linux Sound Subsystem Documentation', |
379 | 'The kernel development community', 'manual'), | 381 | 'The kernel development community', 'manual'), |
380 | ('userspace-api/index', 'userspace-api.tex', 'The Linux kernel user-space API guide', | 382 | ('userspace-api/index', 'userspace-api.tex', 'The Linux kernel user-space API guide', |
diff --git a/Documentation/index.rst b/Documentation/index.rst index 25c4da41da6b..e9017bb3a6ce 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst | |||
@@ -76,6 +76,17 @@ needed). | |||
76 | crypto/index | 76 | crypto/index |
77 | filesystems/index | 77 | filesystems/index |
78 | 78 | ||
79 | Architecture-specific documentation | ||
80 | ----------------------------------- | ||
81 | |||
82 | These books provide programming details about architecture-specific | ||
83 | implementation. | ||
84 | |||
85 | .. toctree:: | ||
86 | :maxdepth: 2 | ||
87 | |||
88 | sh/index | ||
89 | |||
79 | Korean translations | 90 | Korean translations |
80 | ------------------- | 91 | ------------------- |
81 | 92 | ||
diff --git a/Documentation/sh/conf.py b/Documentation/sh/conf.py new file mode 100644 index 000000000000..1eb684a13ac8 --- /dev/null +++ b/Documentation/sh/conf.py | |||
@@ -0,0 +1,10 @@ | |||
1 | # -*- coding: utf-8; mode: python -*- | ||
2 | |||
3 | project = "SuperH architecture implementation manual" | ||
4 | |||
5 | tags.add("subproject") | ||
6 | |||
7 | latex_documents = [ | ||
8 | ('index', 'sh.tex', project, | ||
9 | 'The kernel development community', 'manual'), | ||
10 | ] | ||
diff --git a/Documentation/sh/index.rst b/Documentation/sh/index.rst new file mode 100644 index 000000000000..bc8db7ba894a --- /dev/null +++ b/Documentation/sh/index.rst | |||
@@ -0,0 +1,59 @@ | |||
1 | ======================= | ||
2 | SuperH Interfaces Guide | ||
3 | ======================= | ||
4 | |||
5 | :Author: Paul Mundt | ||
6 | |||
7 | Memory Management | ||
8 | ================= | ||
9 | |||
10 | SH-4 | ||
11 | ---- | ||
12 | |||
13 | Store Queue API | ||
14 | ~~~~~~~~~~~~~~~ | ||
15 | |||
16 | .. kernel-doc:: arch/sh/kernel/cpu/sh4/sq.c | ||
17 | :export: | ||
18 | |||
19 | SH-5 | ||
20 | ---- | ||
21 | |||
22 | TLB Interfaces | ||
23 | ~~~~~~~~~~~~~~ | ||
24 | |||
25 | .. kernel-doc:: arch/sh/mm/tlb-sh5.c | ||
26 | :internal: | ||
27 | |||
28 | .. kernel-doc:: arch/sh/include/asm/tlb_64.h | ||
29 | :internal: | ||
30 | |||
31 | Machine Specific Interfaces | ||
32 | =========================== | ||
33 | |||
34 | mach-dreamcast | ||
35 | -------------- | ||
36 | |||
37 | .. kernel-doc:: arch/sh/boards/mach-dreamcast/rtc.c | ||
38 | :internal: | ||
39 | |||
40 | mach-x3proto | ||
41 | ------------ | ||
42 | |||
43 | .. kernel-doc:: arch/sh/boards/mach-x3proto/ilsel.c | ||
44 | :export: | ||
45 | |||
46 | Busses | ||
47 | ====== | ||
48 | |||
49 | SuperHyway | ||
50 | ---------- | ||
51 | |||
52 | .. kernel-doc:: drivers/sh/superhyway/superhyway.c | ||
53 | :export: | ||
54 | |||
55 | Maple | ||
56 | ----- | ||
57 | |||
58 | .. kernel-doc:: drivers/sh/maple/maple.c | ||
59 | :export: | ||