diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-12 08:14:02 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 07:44:13 -0400 |
commit | 05e0f3b9966c4d6ee8e051607e2ede17b06218c4 (patch) | |
tree | dbf5e69b839c08c45b6de82e082030e4808023a6 /Documentation | |
parent | bcb1a87a8b94182f57312a8d93dc69e9a3ace9e8 (diff) |
docs-rst: convert networking 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 | 1 | ||||
-rw-r--r-- | Documentation/DocBook/networking.tmpl | 111 | ||||
-rw-r--r-- | Documentation/conf.py | 2 | ||||
-rw-r--r-- | Documentation/index.rst | 1 | ||||
-rw-r--r-- | Documentation/networking/conf.py | 10 | ||||
-rw-r--r-- | Documentation/networking/index.rst | 17 | ||||
-rw-r--r-- | Documentation/networking/kapi.rst | 147 |
7 files changed, 177 insertions, 112 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index a25bf10384e1..8a90891c3712 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -7,7 +7,6 @@ | |||
7 | # list of DOCBOOKS. | 7 | # list of DOCBOOKS. |
8 | 8 | ||
9 | DOCBOOKS := z8530book.xml \ | 9 | DOCBOOKS := z8530book.xml \ |
10 | networking.xml \ | ||
11 | lsm.xml \ | 10 | lsm.xml \ |
12 | mtdnand.xml librs.xml rapidio.xml \ | 11 | mtdnand.xml librs.xml rapidio.xml \ |
13 | scsi.xml \ | 12 | scsi.xml \ |
diff --git a/Documentation/DocBook/networking.tmpl b/Documentation/DocBook/networking.tmpl deleted file mode 100644 index 29df25016c7c..000000000000 --- a/Documentation/DocBook/networking.tmpl +++ /dev/null | |||
@@ -1,111 +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="LinuxNetworking"> | ||
6 | <bookinfo> | ||
7 | <title>Linux Networking and Network Devices APIs</title> | ||
8 | |||
9 | <legalnotice> | ||
10 | <para> | ||
11 | This documentation is free software; you can redistribute | ||
12 | it and/or modify it under the terms of the GNU General Public | ||
13 | License as published by the Free Software Foundation; either | ||
14 | version 2 of the License, or (at your option) any later | ||
15 | version. | ||
16 | </para> | ||
17 | |||
18 | <para> | ||
19 | This program is distributed in the hope that it will be | ||
20 | useful, but WITHOUT ANY WARRANTY; without even the implied | ||
21 | warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | ||
22 | See the GNU General Public License for more details. | ||
23 | </para> | ||
24 | |||
25 | <para> | ||
26 | You should have received a copy of the GNU General Public | ||
27 | License along with this program; if not, write to the Free | ||
28 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, | ||
29 | MA 02111-1307 USA | ||
30 | </para> | ||
31 | |||
32 | <para> | ||
33 | For more details see the file COPYING in the source | ||
34 | distribution of Linux. | ||
35 | </para> | ||
36 | </legalnotice> | ||
37 | </bookinfo> | ||
38 | |||
39 | <toc></toc> | ||
40 | |||
41 | <chapter id="netcore"> | ||
42 | <title>Linux Networking</title> | ||
43 | <sect1><title>Networking Base Types</title> | ||
44 | !Iinclude/linux/net.h | ||
45 | </sect1> | ||
46 | <sect1><title>Socket Buffer Functions</title> | ||
47 | !Iinclude/linux/skbuff.h | ||
48 | !Iinclude/net/sock.h | ||
49 | !Enet/socket.c | ||
50 | !Enet/core/skbuff.c | ||
51 | !Enet/core/sock.c | ||
52 | !Enet/core/datagram.c | ||
53 | !Enet/core/stream.c | ||
54 | </sect1> | ||
55 | <sect1><title>Socket Filter</title> | ||
56 | !Enet/core/filter.c | ||
57 | </sect1> | ||
58 | <sect1><title>Generic Network Statistics</title> | ||
59 | !Iinclude/uapi/linux/gen_stats.h | ||
60 | !Enet/core/gen_stats.c | ||
61 | !Enet/core/gen_estimator.c | ||
62 | </sect1> | ||
63 | <sect1><title>SUN RPC subsystem</title> | ||
64 | <!-- The !D functionality is not perfect, garbage has to be protected by comments | ||
65 | !Dnet/sunrpc/sunrpc_syms.c | ||
66 | --> | ||
67 | !Enet/sunrpc/xdr.c | ||
68 | !Enet/sunrpc/svc_xprt.c | ||
69 | !Enet/sunrpc/xprt.c | ||
70 | !Enet/sunrpc/sched.c | ||
71 | !Enet/sunrpc/socklib.c | ||
72 | !Enet/sunrpc/stats.c | ||
73 | !Enet/sunrpc/rpc_pipe.c | ||
74 | !Enet/sunrpc/rpcb_clnt.c | ||
75 | !Enet/sunrpc/clnt.c | ||
76 | </sect1> | ||
77 | <sect1><title>WiMAX</title> | ||
78 | !Enet/wimax/op-msg.c | ||
79 | !Enet/wimax/op-reset.c | ||
80 | !Enet/wimax/op-rfkill.c | ||
81 | !Enet/wimax/stack.c | ||
82 | !Iinclude/net/wimax.h | ||
83 | !Iinclude/uapi/linux/wimax.h | ||
84 | </sect1> | ||
85 | </chapter> | ||
86 | |||
87 | <chapter id="netdev"> | ||
88 | <title>Network device support</title> | ||
89 | <sect1><title>Driver Support</title> | ||
90 | !Enet/core/dev.c | ||
91 | !Enet/ethernet/eth.c | ||
92 | !Enet/sched/sch_generic.c | ||
93 | !Iinclude/linux/etherdevice.h | ||
94 | !Iinclude/linux/netdevice.h | ||
95 | </sect1> | ||
96 | <sect1><title>PHY Support</title> | ||
97 | !Edrivers/net/phy/phy.c | ||
98 | !Idrivers/net/phy/phy.c | ||
99 | !Edrivers/net/phy/phy_device.c | ||
100 | !Idrivers/net/phy/phy_device.c | ||
101 | !Edrivers/net/phy/mdio_bus.c | ||
102 | !Idrivers/net/phy/mdio_bus.c | ||
103 | </sect1> | ||
104 | <!-- FIXME: Removed for now since no structured comments in source | ||
105 | <sect1><title>Wireless</title> | ||
106 | X!Enet/core/wireless.c | ||
107 | </sect1> | ||
108 | --> | ||
109 | </chapter> | ||
110 | |||
111 | </book> | ||
diff --git a/Documentation/conf.py b/Documentation/conf.py index ad9a4781b330..dfe14f7525d0 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py | |||
@@ -369,6 +369,8 @@ latex_documents = [ | |||
369 | 'The kernel development community', 'manual'), | 369 | 'The kernel development community', 'manual'), |
370 | ('media/index', 'media.tex', 'Linux Media Subsystem Documentation', | 370 | ('media/index', 'media.tex', 'Linux Media Subsystem Documentation', |
371 | 'The kernel development community', 'manual'), | 371 | 'The kernel development community', 'manual'), |
372 | ('networking/index', 'networking.tex', 'Linux Networking Documentation', | ||
373 | 'The kernel development community', 'manual'), | ||
372 | ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', | 374 | ('process/index', 'development-process.tex', 'Linux Kernel Development Documentation', |
373 | 'The kernel development community', 'manual'), | 375 | 'The kernel development community', 'manual'), |
374 | ('security/index', 'security.tex', 'The kernel security subsystem manual', | 376 | ('security/index', 'security.tex', 'The kernel security subsystem manual', |
diff --git a/Documentation/index.rst b/Documentation/index.rst index dae365f3820e..25c4da41da6b 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst | |||
@@ -68,6 +68,7 @@ needed). | |||
68 | driver-api/index | 68 | driver-api/index |
69 | core-api/index | 69 | core-api/index |
70 | media/index | 70 | media/index |
71 | networking/index | ||
71 | input/index | 72 | input/index |
72 | gpu/index | 73 | gpu/index |
73 | security/index | 74 | security/index |
diff --git a/Documentation/networking/conf.py b/Documentation/networking/conf.py new file mode 100644 index 000000000000..40f69e67a883 --- /dev/null +++ b/Documentation/networking/conf.py | |||
@@ -0,0 +1,10 @@ | |||
1 | # -*- coding: utf-8; mode: python -*- | ||
2 | |||
3 | project = "Linux Networking Documentation" | ||
4 | |||
5 | tags.add("subproject") | ||
6 | |||
7 | latex_documents = [ | ||
8 | ('index', 'networking.tex', project, | ||
9 | 'The kernel development community', 'manual'), | ||
10 | ] | ||
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst new file mode 100644 index 000000000000..ff652ff279e8 --- /dev/null +++ b/Documentation/networking/index.rst | |||
@@ -0,0 +1,17 @@ | |||
1 | Linux Networking Documentation | ||
2 | ============================== | ||
3 | |||
4 | Contents: | ||
5 | |||
6 | .. toctree:: | ||
7 | :maxdepth: 2 | ||
8 | |||
9 | kapi | ||
10 | |||
11 | .. only:: subproject | ||
12 | |||
13 | Indices | ||
14 | ======= | ||
15 | |||
16 | * :ref:`genindex` | ||
17 | |||
diff --git a/Documentation/networking/kapi.rst b/Documentation/networking/kapi.rst new file mode 100644 index 000000000000..580289f345da --- /dev/null +++ b/Documentation/networking/kapi.rst | |||
@@ -0,0 +1,147 @@ | |||
1 | ========================================= | ||
2 | Linux Networking and Network Devices APIs | ||
3 | ========================================= | ||
4 | |||
5 | Linux Networking | ||
6 | ================ | ||
7 | |||
8 | Networking Base Types | ||
9 | --------------------- | ||
10 | |||
11 | .. kernel-doc:: include/linux/net.h | ||
12 | :internal: | ||
13 | |||
14 | Socket Buffer Functions | ||
15 | ----------------------- | ||
16 | |||
17 | .. kernel-doc:: include/linux/skbuff.h | ||
18 | :internal: | ||
19 | |||
20 | .. kernel-doc:: include/net/sock.h | ||
21 | :internal: | ||
22 | |||
23 | .. kernel-doc:: net/socket.c | ||
24 | :export: | ||
25 | |||
26 | .. kernel-doc:: net/core/skbuff.c | ||
27 | :export: | ||
28 | |||
29 | .. kernel-doc:: net/core/sock.c | ||
30 | :export: | ||
31 | |||
32 | .. kernel-doc:: net/core/datagram.c | ||
33 | :export: | ||
34 | |||
35 | .. kernel-doc:: net/core/stream.c | ||
36 | :export: | ||
37 | |||
38 | Socket Filter | ||
39 | ------------- | ||
40 | |||
41 | .. kernel-doc:: net/core/filter.c | ||
42 | :export: | ||
43 | |||
44 | Generic Network Statistics | ||
45 | -------------------------- | ||
46 | |||
47 | .. kernel-doc:: include/uapi/linux/gen_stats.h | ||
48 | :internal: | ||
49 | |||
50 | .. kernel-doc:: net/core/gen_stats.c | ||
51 | :export: | ||
52 | |||
53 | .. kernel-doc:: net/core/gen_estimator.c | ||
54 | :export: | ||
55 | |||
56 | SUN RPC subsystem | ||
57 | ----------------- | ||
58 | |||
59 | .. kernel-doc:: net/sunrpc/xdr.c | ||
60 | :export: | ||
61 | |||
62 | .. kernel-doc:: net/sunrpc/svc_xprt.c | ||
63 | :export: | ||
64 | |||
65 | .. kernel-doc:: net/sunrpc/xprt.c | ||
66 | :export: | ||
67 | |||
68 | .. kernel-doc:: net/sunrpc/sched.c | ||
69 | :export: | ||
70 | |||
71 | .. kernel-doc:: net/sunrpc/socklib.c | ||
72 | :export: | ||
73 | |||
74 | .. kernel-doc:: net/sunrpc/stats.c | ||
75 | :export: | ||
76 | |||
77 | .. kernel-doc:: net/sunrpc/rpc_pipe.c | ||
78 | :export: | ||
79 | |||
80 | .. kernel-doc:: net/sunrpc/rpcb_clnt.c | ||
81 | :export: | ||
82 | |||
83 | .. kernel-doc:: net/sunrpc/clnt.c | ||
84 | :export: | ||
85 | |||
86 | WiMAX | ||
87 | ----- | ||
88 | |||
89 | .. kernel-doc:: net/wimax/op-msg.c | ||
90 | :export: | ||
91 | |||
92 | .. kernel-doc:: net/wimax/op-reset.c | ||
93 | :export: | ||
94 | |||
95 | .. kernel-doc:: net/wimax/op-rfkill.c | ||
96 | :export: | ||
97 | |||
98 | .. kernel-doc:: net/wimax/stack.c | ||
99 | :export: | ||
100 | |||
101 | .. kernel-doc:: include/net/wimax.h | ||
102 | :internal: | ||
103 | |||
104 | .. kernel-doc:: include/uapi/linux/wimax.h | ||
105 | :internal: | ||
106 | |||
107 | Network device support | ||
108 | ====================== | ||
109 | |||
110 | Driver Support | ||
111 | -------------- | ||
112 | |||
113 | .. kernel-doc:: net/core/dev.c | ||
114 | :export: | ||
115 | |||
116 | .. kernel-doc:: net/ethernet/eth.c | ||
117 | :export: | ||
118 | |||
119 | .. kernel-doc:: net/sched/sch_generic.c | ||
120 | :export: | ||
121 | |||
122 | .. kernel-doc:: include/linux/etherdevice.h | ||
123 | :internal: | ||
124 | |||
125 | .. kernel-doc:: include/linux/netdevice.h | ||
126 | :internal: | ||
127 | |||
128 | PHY Support | ||
129 | ----------- | ||
130 | |||
131 | .. kernel-doc:: drivers/net/phy/phy.c | ||
132 | :export: | ||
133 | |||
134 | .. kernel-doc:: drivers/net/phy/phy.c | ||
135 | :internal: | ||
136 | |||
137 | .. kernel-doc:: drivers/net/phy/phy_device.c | ||
138 | :export: | ||
139 | |||
140 | .. kernel-doc:: drivers/net/phy/phy_device.c | ||
141 | :internal: | ||
142 | |||
143 | .. kernel-doc:: drivers/net/phy/mdio_bus.c | ||
144 | :export: | ||
145 | |||
146 | .. kernel-doc:: drivers/net/phy/mdio_bus.c | ||
147 | :internal: | ||