diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-02-13 18:03:25 -0500 |
---|---|---|
committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2008-02-13 19:21:19 -0500 |
commit | bc2cda1ebd4430f55deb60f0193a3e3b835499a2 (patch) | |
tree | c9f6a03a04a6540822abc693395261b035dcb045 /Documentation/DocBook | |
parent | 65b6e42cdc5b6a1ce2ada31cc294d7e60b22bb43 (diff) |
docbook: make a networking book and fix a few errors
Move networking (core and drivers) docbook to its own networking book.
Fix a few kernel-doc errors in header and source files.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Trond Myklebust <trond.myklebust@fys.uio.no>
Cc: "J. Bruce Fields" <bfields@fieldses.org>
Cc: Neil Brown <neilb@suse.de>
Cc: "David S. Miller" <davem@davemloft.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/Makefile | 2 | ||||
-rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 65 | ||||
-rw-r--r-- | Documentation/DocBook/networking.tmpl | 106 |
3 files changed, 107 insertions, 66 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 6a0ad4715e9..300e1707893 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -8,7 +8,7 @@ | |||
8 | 8 | ||
9 | DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ | 9 | DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ |
10 | kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ | 10 | kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ |
11 | procfs-guide.xml writing_usb_driver.xml \ | 11 | procfs-guide.xml writing_usb_driver.xml networking.xml \ |
12 | kernel-api.xml filesystems.xml lsm.xml usb.xml \ | 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml \ |
13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ | 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ |
14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml | 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml |
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index 6c0e5f01861..7e054c9124e 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
@@ -204,71 +204,6 @@ X!Ilib/string.c | |||
204 | </sect1> | 204 | </sect1> |
205 | </chapter> | 205 | </chapter> |
206 | 206 | ||
207 | <chapter id="netcore"> | ||
208 | <title>Linux Networking</title> | ||
209 | <sect1><title>Networking Base Types</title> | ||
210 | !Iinclude/linux/net.h | ||
211 | </sect1> | ||
212 | <sect1><title>Socket Buffer Functions</title> | ||
213 | !Iinclude/linux/skbuff.h | ||
214 | !Iinclude/net/sock.h | ||
215 | !Enet/socket.c | ||
216 | !Enet/core/skbuff.c | ||
217 | !Enet/core/sock.c | ||
218 | !Enet/core/datagram.c | ||
219 | !Enet/core/stream.c | ||
220 | </sect1> | ||
221 | <sect1><title>Socket Filter</title> | ||
222 | !Enet/core/filter.c | ||
223 | </sect1> | ||
224 | <sect1><title>Generic Network Statistics</title> | ||
225 | !Iinclude/linux/gen_stats.h | ||
226 | !Enet/core/gen_stats.c | ||
227 | !Enet/core/gen_estimator.c | ||
228 | </sect1> | ||
229 | <sect1><title>SUN RPC subsystem</title> | ||
230 | <!-- The !D functionality is not perfect, garbage has to be protected by comments | ||
231 | !Dnet/sunrpc/sunrpc_syms.c | ||
232 | --> | ||
233 | !Enet/sunrpc/xdr.c | ||
234 | !Enet/sunrpc/svc_xprt.c | ||
235 | !Enet/sunrpc/xprt.c | ||
236 | !Enet/sunrpc/sched.c | ||
237 | !Enet/sunrpc/socklib.c | ||
238 | !Enet/sunrpc/stats.c | ||
239 | !Enet/sunrpc/rpc_pipe.c | ||
240 | !Enet/sunrpc/rpcb_clnt.c | ||
241 | !Enet/sunrpc/clnt.c | ||
242 | </sect1> | ||
243 | </chapter> | ||
244 | |||
245 | <chapter id="netdev"> | ||
246 | <title>Network device support</title> | ||
247 | <sect1><title>Driver Support</title> | ||
248 | !Enet/core/dev.c | ||
249 | !Enet/ethernet/eth.c | ||
250 | !Enet/sched/sch_generic.c | ||
251 | !Iinclude/linux/etherdevice.h | ||
252 | !Iinclude/linux/netdevice.h | ||
253 | </sect1> | ||
254 | <sect1><title>PHY Support</title> | ||
255 | !Edrivers/net/phy/phy.c | ||
256 | !Idrivers/net/phy/phy.c | ||
257 | !Edrivers/net/phy/phy_device.c | ||
258 | !Idrivers/net/phy/phy_device.c | ||
259 | !Edrivers/net/phy/mdio_bus.c | ||
260 | !Idrivers/net/phy/mdio_bus.c | ||
261 | </sect1> | ||
262 | <!-- FIXME: Removed for now since no structured comments in source | ||
263 | <sect1><title>Wireless</title> | ||
264 | X!Enet/core/wireless.c | ||
265 | </sect1> | ||
266 | --> | ||
267 | <sect1><title>Synchronous PPP</title> | ||
268 | !Edrivers/net/wan/syncppp.c | ||
269 | </sect1> | ||
270 | </chapter> | ||
271 | |||
272 | <chapter id="modload"> | 207 | <chapter id="modload"> |
273 | <title>Module Support</title> | 208 | <title>Module Support</title> |
274 | <sect1><title>Module Loading</title> | 209 | <sect1><title>Module Loading</title> |
diff --git a/Documentation/DocBook/networking.tmpl b/Documentation/DocBook/networking.tmpl new file mode 100644 index 00000000000..f24f9e85e4a --- /dev/null +++ b/Documentation/DocBook/networking.tmpl | |||
@@ -0,0 +1,106 @@ | |||
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/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 | </chapter> | ||
78 | |||
79 | <chapter id="netdev"> | ||
80 | <title>Network device support</title> | ||
81 | <sect1><title>Driver Support</title> | ||
82 | !Enet/core/dev.c | ||
83 | !Enet/ethernet/eth.c | ||
84 | !Enet/sched/sch_generic.c | ||
85 | !Iinclude/linux/etherdevice.h | ||
86 | !Iinclude/linux/netdevice.h | ||
87 | </sect1> | ||
88 | <sect1><title>PHY Support</title> | ||
89 | !Edrivers/net/phy/phy.c | ||
90 | !Idrivers/net/phy/phy.c | ||
91 | !Edrivers/net/phy/phy_device.c | ||
92 | !Idrivers/net/phy/phy_device.c | ||
93 | !Edrivers/net/phy/mdio_bus.c | ||
94 | !Idrivers/net/phy/mdio_bus.c | ||
95 | </sect1> | ||
96 | <!-- FIXME: Removed for now since no structured comments in source | ||
97 | <sect1><title>Wireless</title> | ||
98 | X!Enet/core/wireless.c | ||
99 | </sect1> | ||
100 | --> | ||
101 | <sect1><title>Synchronous PPP</title> | ||
102 | !Edrivers/net/wan/syncppp.c | ||
103 | </sect1> | ||
104 | </chapter> | ||
105 | |||
106 | </book> | ||