diff options
| author |   Jonathan Corbet <corbet@lwn.net> | 2017-01-27 15:43:01 -0700 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-01-31 17:31:21 -0700 |
| commit | 8a8a602fdb834ffce9cf3e9f6021a86cdada78f0 (patch) | |
| tree | dd0f2ec85b870a8fd5a5bd17dc3868fa279cae6f /Documentation/driver-api/index.rst | |
| parent | docs/zh_CN: Add coding-style into docs build system (diff) | |
| download | linux-dev-8a8a602fdb834ffce9cf3e9f6021a86cdada78f0.tar.xz linux-dev-8a8a602fdb834ffce9cf3e9f6021a86cdada78f0.zip | |
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>
Diffstat (limited to 'Documentation/driver-api/index.rst')
| -rw-r--r-- | Documentation/driver-api/index.rst | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index a2e5db07756c..365ce64abd7c 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -16,6 +16,7 @@ available subsections can be seen below. basics infrastructure + device-io dma-buf device_link message-based |