This short series convers device-drivers.tmpl into the RST format, splits
it up, and sets up the result under Documentation/driver-api/. For added
fun, I've taken one top-level file (hsi.txt) and folded it into the
document as a way of showing the direction I'm thinking I would like things
to go. There is plenty more of this sort of work that could be done, to
say the least - this is just a beginning!
The formatted results can be seen at:
http://static.lwn.net/kerneldoc/driver-api/index.html
As part of the long-term task to turn Documentation/ into less of a horror
movie, I'd like to collect documentation of the driver-specific API here.
Arguably gpu/ and the media API stuff should eventually move here, though
we can discuss the color of that particular shed some other day.
Meanwhile, I'd appreciate comments on the general idea.
Cc: Jani Nikula <jani.nikula@xxxxxxxxx>
Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
Cc: Sebastian Reichel <sre@xxxxxxxxxx>
Jonathan Corbet (3):
Docs: sphinxify device-drivers.tmpl
docs: split up the driver book
docs: Pull HSI documentation together
Documentation/DocBook/Makefile | 2 +-
Documentation/DocBook/device-drivers.tmpl | 521 -------------------------
Documentation/driver-api/basics.rst | 120 ++++++
Documentation/driver-api/frame-buffer.rst | 62 +++
Documentation/driver-api/index.rst | 24 ++
Documentation/driver-api/infrastructure.rst | 169 ++++++++
Documentation/driver-api/input.rst | 51 +++
Documentation/driver-api/message-based.rst | 30 ++
Documentation/driver-api/miscellaneous.rst | 50 +++
Documentation/driver-api/serial-interfaces.rst | 189 +++++++++
Documentation/driver-api/sound.rst | 54 +++
Documentation/hsi.txt | 75 ----
Documentation/index.rst | 1 +
MAINTAINERS | 2 +-
14 files changed, 752 insertions(+), 598 deletions(-)
delete mode 100644 Documentation/DocBook/device-drivers.tmpl
create mode 100644 Documentation/driver-api/basics.rst
create mode 100644 Documentation/driver-api/frame-buffer.rst
create mode 100644 Documentation/driver-api/index.rst
create mode 100644 Documentation/driver-api/infrastructure.rst
create mode 100644 Documentation/driver-api/input.rst
create mode 100644 Documentation/driver-api/message-based.rst
create mode 100644 Documentation/driver-api/miscellaneous.rst
create mode 100644 Documentation/driver-api/serial-interfaces.rst
create mode 100644 Documentation/driver-api/sound.rst
delete mode 100644 Documentation/hsi.txt
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
