]> git.baikalelectronics.ru Git - kernel.git/commit
docs: Convert the deviceio template to RST
authorJonathan Corbet <corbet@lwn.net>
Fri, 27 Jan 2017 22:43:01 +0000 (15:43 -0700)
committerJonathan Corbet <corbet@lwn.net>
Wed, 1 Feb 2017 00:31:21 +0000 (17:31 -0700)
commit8a8a602fdb834ffce9cf3e9f6021a86cdada78f0
treedd0f2ec85b870a8fd5a5bd17dc3868fa279cae6f
parent2069889ff78cb00fa274818b03cec6d976b3187c
docs: Convert the deviceio template to RST

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>
Documentation/DocBook/deviceiobook.tmpl [deleted file]
Documentation/driver-api/device-io.rst [new file with mode: 0644]
Documentation/driver-api/index.rst