docs: Convert the deviceio template to RST

Browse source

Convert deviceiobook.tmpl to RST and incorporate it into the driver API
manual.

Like the rest of our documentation, this one could use some work.  There's
no mention of ioremap() and friends, no mention of io_read*() and friends.
But we have nice documentation for all those folks writing new drivers that
do port I/O :).

The :c:func: notation has been left off of all the read*/write* functions.
There's no kerneldoc comments for them anyway, so those links will never be
live, and writing a bunch of repetitive "read a byte from I/O memory"
comments lacks appeal.

Cc: Matthew Wilcox <willy@infradead.org>
Cc: Alan Cox <gnomes@lxorguk.ukuu.org.uk>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

...

This commit is contained in:

Jonathan Corbet 2017-01-27 15:43:01 -07:00

parent 2069889ff7

commit 8a8a602fdb

3 changed files with 202 additions and 323 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

323

Documentation/DocBook/deviceiobook.tmpl

View file

201

Documentation/driver-api/device-io.rst

View file

1

Documentation/driver-api/index.rst

View file