Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 352de557 authored by Johannes Berg's avatar Johannes Berg Committed by John W. Linville
Browse files

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: default avatarJohannes Berg <johannes.berg@intel.com>
Signed-off-by: default avatarJohn W. Linville <linville@tuxdriver.com>
parent d7eb50c0

Documentation/DocBook/mac80211.tmpl→Documentation/DocBook/80211.tmpl

+371 −0
Original line number Diff line number Diff line 
<?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" []>

<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">

  <bookinfo>

    <title>The mac80211 subsystem for kernel developers</title>

    <copyright>

      <year>2007-2009</year>

      <holder>Johannes Berg</holder>

    </copyright>



    <authorgroup>

      <author>
@@ -16,32 +23,24 @@ 
      </author>

    </authorgroup>



    <copyright>

      <year>2007-2009</year>

      <holder>Johannes Berg</holder>

    </copyright>



    <legalnotice>

      <para>

        This documentation is free software; you can redistribute

        it and/or modify it under the terms of the GNU General Public

        License version 2 as published by the Free Software Foundation.

      </para>



      <para>

        This documentation 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 documentation; 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.
@@ -49,6 +48,40 @@ 
    </legalnotice>



    <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 Warning

      </abstract>
@@ -335,3 +368,4 @@ usage should require reading the full document. 
      </chapter>

    </part>

  </book>

</set>

Documentation/DocBook/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \ 
	    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \

	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.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 \

	    tracepoint.xml media.xml drm.xml