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>zero-colors
Mauro Carvalho Chehab
parent
bcb1a87a8b
commit
05e0f3b996
|
|
@ -7,7 +7,6 @@
|
|||
# list of DOCBOOKS.
|
||||
|
||||
DOCBOOKS := z8530book.xml \
|
||||
networking.xml \
|
||||
lsm.xml \
|
||||
mtdnand.xml librs.xml rapidio.xml \
|
||||
scsi.xml \
|
||||
|
|
|
|||
|
|
@ -1,111 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
|
||||
|
||||
<book id="LinuxNetworking">
|
||||
<bookinfo>
|
||||
<title>Linux Networking and Network Devices APIs</title>
|
||||
|
||||
<legalnotice>
|
||||
<para>
|
||||
This documentation is free software; you can redistribute
|
||||
it and/or modify it under the terms of the GNU General Public
|
||||
License as published by the Free Software Foundation; either
|
||||
version 2 of the License, or (at your option) any later
|
||||
version.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This program is distributed in the hope that it will be
|
||||
useful, but WITHOUT ANY WARRANTY; without even the implied
|
||||
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
See the GNU General Public License for more details.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You should have received a copy of the GNU General Public
|
||||
License along with this program; if not, write to the Free
|
||||
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
||||
MA 02111-1307 USA
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For more details see the file COPYING in the source
|
||||
distribution of Linux.
|
||||
</para>
|
||||
</legalnotice>
|
||||
</bookinfo>
|
||||
|
||||
<toc></toc>
|
||||
|
||||
<chapter id="netcore">
|
||||
<title>Linux Networking</title>
|
||||
<sect1><title>Networking Base Types</title>
|
||||
!Iinclude/linux/net.h
|
||||
</sect1>
|
||||
<sect1><title>Socket Buffer Functions</title>
|
||||
!Iinclude/linux/skbuff.h
|
||||
!Iinclude/net/sock.h
|
||||
!Enet/socket.c
|
||||
!Enet/core/skbuff.c
|
||||
!Enet/core/sock.c
|
||||
!Enet/core/datagram.c
|
||||
!Enet/core/stream.c
|
||||
</sect1>
|
||||
<sect1><title>Socket Filter</title>
|
||||
!Enet/core/filter.c
|
||||
</sect1>
|
||||
<sect1><title>Generic Network Statistics</title>
|
||||
!Iinclude/uapi/linux/gen_stats.h
|
||||
!Enet/core/gen_stats.c
|
||||
!Enet/core/gen_estimator.c
|
||||
</sect1>
|
||||
<sect1><title>SUN RPC subsystem</title>
|
||||
<!-- The !D functionality is not perfect, garbage has to be protected by comments
|
||||
!Dnet/sunrpc/sunrpc_syms.c
|
||||
-->
|
||||
!Enet/sunrpc/xdr.c
|
||||
!Enet/sunrpc/svc_xprt.c
|
||||
!Enet/sunrpc/xprt.c
|
||||
!Enet/sunrpc/sched.c
|
||||
!Enet/sunrpc/socklib.c
|
||||
!Enet/sunrpc/stats.c
|
||||
!Enet/sunrpc/rpc_pipe.c
|
||||
!Enet/sunrpc/rpcb_clnt.c
|
||||
!Enet/sunrpc/clnt.c
|
||||
</sect1>
|
||||
<sect1><title>WiMAX</title>
|
||||
!Enet/wimax/op-msg.c
|
||||
!Enet/wimax/op-reset.c
|
||||
!Enet/wimax/op-rfkill.c
|
||||
!Enet/wimax/stack.c
|
||||
!Iinclude/net/wimax.h
|
||||
!Iinclude/uapi/linux/wimax.h
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
||||
<chapter id="netdev">
|
||||
<title>Network device support</title>
|
||||
<sect1><title>Driver Support</title>
|
||||
!Enet/core/dev.c
|
||||
!Enet/ethernet/eth.c
|
||||
!Enet/sched/sch_generic.c
|
||||
!Iinclude/linux/etherdevice.h
|
||||
!Iinclude/linux/netdevice.h
|
||||
</sect1>
|
||||
<sect1><title>PHY Support</title>
|
||||
!Edrivers/net/phy/phy.c
|
||||
!Idrivers/net/phy/phy.c
|
||||
!Edrivers/net/phy/phy_device.c
|
||||
!Idrivers/net/phy/phy_device.c
|
||||
!Edrivers/net/phy/mdio_bus.c
|
||||
!Idrivers/net/phy/mdio_bus.c
|
||||
</sect1>
|
||||
<!-- FIXME: Removed for now since no structured comments in source
|
||||
<sect1><title>Wireless</title>
|
||||
X!Enet/core/wireless.c
|
||||
</sect1>
|
||||
-->
|
||||
</chapter>
|
||||
|
||||
</book>
|
||||
|
|
@ -369,6 +369,8 @@ latex_documents = [
|
|||
'The kernel development community', 'manual'),
|
||||
('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
|
||||
'The kernel development community', 'manual'),
|
||||
('networking/index', 'networking.tex', 'Linux Networking Documentation',
|
||||
'The kernel development community', 'manual'),
|
||||
('process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
|
||||
'The kernel development community', 'manual'),
|
||||
('security/index', 'security.tex', 'The kernel security subsystem manual',
|
||||
|
|
|
|||
|
|
@ -68,6 +68,7 @@ needed).
|
|||
driver-api/index
|
||||
core-api/index
|
||||
media/index
|
||||
networking/index
|
||||
input/index
|
||||
gpu/index
|
||||
security/index
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
# -*- coding: utf-8; mode: python -*-
|
||||
|
||||
project = "Linux Networking Documentation"
|
||||
|
||||
tags.add("subproject")
|
||||
|
||||
latex_documents = [
|
||||
('index', 'networking.tex', project,
|
||||
'The kernel development community', 'manual'),
|
||||
]
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
Linux Networking Documentation
|
||||
==============================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
kapi
|
||||
|
||||
.. only:: subproject
|
||||
|
||||
Indices
|
||||
=======
|
||||
|
||||
* :ref:`genindex`
|
||||
|
||||
|
|
@ -0,0 +1,147 @@
|
|||
=========================================
|
||||
Linux Networking and Network Devices APIs
|
||||
=========================================
|
||||
|
||||
Linux Networking
|
||||
================
|
||||
|
||||
Networking Base Types
|
||||
---------------------
|
||||
|
||||
.. kernel-doc:: include/linux/net.h
|
||||
:internal:
|
||||
|
||||
Socket Buffer Functions
|
||||
-----------------------
|
||||
|
||||
.. kernel-doc:: include/linux/skbuff.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: include/net/sock.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: net/socket.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/core/skbuff.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/core/sock.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/core/datagram.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/core/stream.c
|
||||
:export:
|
||||
|
||||
Socket Filter
|
||||
-------------
|
||||
|
||||
.. kernel-doc:: net/core/filter.c
|
||||
:export:
|
||||
|
||||
Generic Network Statistics
|
||||
--------------------------
|
||||
|
||||
.. kernel-doc:: include/uapi/linux/gen_stats.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: net/core/gen_stats.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/core/gen_estimator.c
|
||||
:export:
|
||||
|
||||
SUN RPC subsystem
|
||||
-----------------
|
||||
|
||||
.. kernel-doc:: net/sunrpc/xdr.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/svc_xprt.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/xprt.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/sched.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/socklib.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/stats.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/rpc_pipe.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/rpcb_clnt.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sunrpc/clnt.c
|
||||
:export:
|
||||
|
||||
WiMAX
|
||||
-----
|
||||
|
||||
.. kernel-doc:: net/wimax/op-msg.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/wimax/op-reset.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/wimax/op-rfkill.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/wimax/stack.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: include/net/wimax.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: include/uapi/linux/wimax.h
|
||||
:internal:
|
||||
|
||||
Network device support
|
||||
======================
|
||||
|
||||
Driver Support
|
||||
--------------
|
||||
|
||||
.. kernel-doc:: net/core/dev.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/ethernet/eth.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: net/sched/sch_generic.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: include/linux/etherdevice.h
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: include/linux/netdevice.h
|
||||
:internal:
|
||||
|
||||
PHY Support
|
||||
-----------
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/phy.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/phy.c
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/phy_device.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/phy_device.c
|
||||
:internal:
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/mdio_bus.c
|
||||
:export:
|
||||
|
||||
.. kernel-doc:: drivers/net/phy/mdio_bus.c
|
||||
:internal:
|
||||
Loading…
Reference in New Issue