提交 352de557 编写于 作者: J Johannes Berg 提交者: John W. Linville

wireless: move documentation books

This moves mac80211 documentation into a new
802.11 bookset and also adds a cfg80211 book
to the set. All of this is rather incomplete,
but it's easier to work with big code moving
as a separate patch.
Signed-off-by: NJohannes Berg <johannes.berg@intel.com>
Signed-off-by: NJohn W. Linville <linville@tuxdriver.com>
上级 d7eb50c0
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" <!DOCTYPE set PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []> "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
<set>
<setinfo>
<title>The 802.11 subsystems &ndash; for kernel developers</title>
<subtitle>
Explaining wireless 802.11 networking in the Linux kernel
</subtitle>
<book id="mac80211-developers-guide"> <copyright>
<bookinfo> <year>2007-2009</year>
<title>The mac80211 subsystem for kernel developers</title> <holder>Johannes Berg</holder>
</copyright>
<authorgroup> <authorgroup>
<author> <author>
...@@ -16,32 +23,24 @@ ...@@ -16,32 +23,24 @@
</author> </author>
</authorgroup> </authorgroup>
<copyright>
<year>2007-2009</year>
<holder>Johannes Berg</holder>
</copyright>
<legalnotice> <legalnotice>
<para> <para>
This documentation is free software; you can redistribute This documentation is free software; you can redistribute
it and/or modify it under the terms of the GNU General Public it and/or modify it under the terms of the GNU General Public
License version 2 as published by the Free Software Foundation. License version 2 as published by the Free Software Foundation.
</para> </para>
<para> <para>
This documentation is distributed in the hope that it will be This documentation is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details. See the GNU General Public License for more details.
</para> </para>
<para> <para>
You should have received a copy of the GNU General Public You should have received a copy of the GNU General Public
License along with this documentation; if not, write to the Free License along with this documentation; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
MA 02111-1307 USA MA 02111-1307 USA
</para> </para>
<para> <para>
For more details see the file COPYING in the source For more details see the file COPYING in the source
distribution of Linux. distribution of Linux.
...@@ -49,6 +48,40 @@ ...@@ -49,6 +48,40 @@
</legalnotice> </legalnotice>
<abstract> <abstract>
<para>
These books attempt to give a description of the
various subsystems that play a role in 802.11 wireless
networking in Linux. Since these books are for kernel
developers they attempts to document the structures
and functions used in the kernel as well as giving a
higher-level overview.
</para>
<para>
The reader is expected to be familiar with the 802.11
standard as published by the IEEE in 802.11-2007 (or
possibly later versions). References to this standard
will be given as "802.11-2007 8.1.5".
</para>
</abstract>
</setinfo>
<book id="cfg80211-developers-guide">
<bookinfo>
<title>The cfg80211 subsystem</title>
<abstract>
<para>
MISSING
</para>
</abstract>
</bookinfo>
<part><chapter>
!Finclude/net/cfg80211.h ieee80211_band
</chapter></part>
</book>
<book id="mac80211-developers-guide">
<bookinfo>
<title>The mac80211 subsystem</title>
<abstract>
!Pinclude/net/mac80211.h Introduction !Pinclude/net/mac80211.h Introduction
!Pinclude/net/mac80211.h Warning !Pinclude/net/mac80211.h Warning
</abstract> </abstract>
...@@ -56,12 +89,12 @@ ...@@ -56,12 +89,12 @@
<toc></toc> <toc></toc>
<!-- <!--
Generally, this document shall be ordered by increasing complexity. Generally, this document shall be ordered by increasing complexity.
It is important to note that readers should be able to read only It is important to note that readers should be able to read only
the first few sections to get a working driver and only advanced the first few sections to get a working driver and only advanced
usage should require reading the full document. usage should require reading the full document.
--> -->
<part> <part>
<title>The basic mac80211 driver interface</title> <title>The basic mac80211 driver interface</title>
...@@ -101,7 +134,7 @@ usage should require reading the full document. ...@@ -101,7 +134,7 @@ usage should require reading the full document.
Finally, a discussion of hardware capabilities should be done Finally, a discussion of hardware capabilities should be done
with references to other parts of the book. with references to other parts of the book.
</para> </para>
<!-- intentionally multiple !F lines to get proper order --> <!-- intentionally multiple !F lines to get proper order -->
!Finclude/net/mac80211.h ieee80211_hw !Finclude/net/mac80211.h ieee80211_hw
!Finclude/net/mac80211.h ieee80211_hw_flags !Finclude/net/mac80211.h ieee80211_hw_flags
!Finclude/net/mac80211.h SET_IEEE80211_DEV !Finclude/net/mac80211.h SET_IEEE80211_DEV
...@@ -212,7 +245,7 @@ usage should require reading the full document. ...@@ -212,7 +245,7 @@ usage should require reading the full document.
<chapter id="hardware-crypto-offload"> <chapter id="hardware-crypto-offload">
<title>Hardware crypto acceleration</title> <title>Hardware crypto acceleration</title>
!Pinclude/net/mac80211.h Hardware crypto acceleration !Pinclude/net/mac80211.h Hardware crypto acceleration
<!-- intentionally multiple !F lines to get proper order --> <!-- intentionally multiple !F lines to get proper order -->
!Finclude/net/mac80211.h set_key_cmd !Finclude/net/mac80211.h set_key_cmd
!Finclude/net/mac80211.h ieee80211_key_conf !Finclude/net/mac80211.h ieee80211_key_conf
!Finclude/net/mac80211.h ieee80211_key_alg !Finclude/net/mac80211.h ieee80211_key_alg
...@@ -334,4 +367,5 @@ usage should require reading the full document. ...@@ -334,4 +367,5 @@ usage should require reading the full document.
<para>Locking, lots of RCU</para> <para>Locking, lots of RCU</para>
</chapter> </chapter>
</part> </part>
</book> </book>
</set>
...@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ ...@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
mac80211.xml debugobjects.xml sh.xml regulator.xml \ 80211.xml debugobjects.xml sh.xml regulator.xml \
alsa-driver-api.xml writing-an-alsa-driver.xml \ alsa-driver-api.xml writing-an-alsa-driver.xml \
tracepoint.xml media.xml drm.xml tracepoint.xml media.xml drm.xml
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册