documenting mac80211

documenting mac80211

[Johannes Berg]

[-- Attachment #1.1: Type: text/plain, Size: 1234 bytes --]

Hey,

After having added all the docbook stuff to mac80211.h I want to
aggregate it into a document. This is really WIP but I hope to attract
some others to document things, often bugs/bad assumptions are found
that way.

Attached is a mac80211.tmpl file suitable for Documentation/DocBook.
Note, however, that it contains !P directives which are not understood
by scripts/basic/docproc.c yet, patches will be fixed up and sent soon.
Hence, I've also uploaded the current documentation to
http://johannes.sipsolutions.net/files/mac80211/

Of course, most of the chapters in that document are empty, they ought
to be filled with contents as time permits. I have structured the
document into four chapters as you can see in the output:
   I. The basic mac80211 driver interface
  II. Advanced driver interface
 III. Rate control interface
  IV. Internals

Obviously, chapter III. can't be written yet because the rate control
interface hasn't been formalised, but maybe we should actually write the
documentation before the code.

Also, a new book on cfg80211 should be written that shall include all
the wiphy stuff and the new regulatory stuff from Luis. But I can only
do so much at a time :)

johannes

[-- Attachment #1.2: mac80211.tmpl --]
[-- Type: application/docbook+xml, Size: 10629 bytes --]

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 190 bytes --]